com.sap.netweaver.bc.rf.mi.version
Interface IAdvancedVersioningManager

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.mi_api.jar]

All Known Subinterfaces:

IMutableAdvancedVersioningManager

public interface IAdvancedVersioningManager

Read-Only interface describing a repository sub manager for the advanced versioning features described below. For an explanation of terminological conventions, please see IBasicVersioningMananger. In addition to the very basic versioning features of IBasicVersionManager , this manager adds support for nonlinear version histories (i.e. forks), the option of sharing version histories between vcrs (i.e. working resources), the option of addressing versions in a version history by a client-defined string (i.e. labels) and the version history resource feature, meaning that the version history is accessible as a resource (in particular, giving it Properties and the delete() method).

Method Summary

IResourceHandle	getAutoUpdateVcr(IResourceHandle workingResourceHandle) Returns a resource handle referring to the version controlled resource from which the given working resource was created and which will automatically be updated when the working resource is checked in.
java.util.Set	getCheckedOutVCRsByVersion(IResourceHandle versionHandle) If the given resource handle refers to a version resource, the set of resource handles referring to checked-out vcrs based on this version will be returned.
java.util.Set	getCheckInForkBehaviour(IResourceHandle versionHandle) Returns a set of IName objects describing the fork behavior of the given version resource on checkin.
java.util.Set	getCheckOutForkBehaviour(IResourceHandle versionHandle) Returns a set of IName objects describing the fork behavior of the given version resource on checkout.
java.util.Set	getLabelSet(IResourceHandle versionHandle) Returns a Set of strings representing the labels defined on the given version resource.
IResourceHandle	getRootVersion(IResourceHandle versionHistoryHandle) Returns a resource handle referring to the version resource that is the root of the given version history (i.e. the first version in the version history).
java.util.Set	getVCRsBasedOnHistory(IResourceHandle scope, IResourceHandle versionHistoryHandle) If the given resource handle refers to a version history resource, a list of resource handles referring to vcrs based on this version history will be returned.
java.util.Set	getVersionHistoryCollections(IResourceHandle vcrHandle) Returns a set of resource handles referring to the collections that are used to store version history resources for the given resource handle.
IResourceHandle	getVersionHistoryResource(IResourceHandle resourceHandle) Returns a resource handle referring to the version history resource of the given vcr or version.
IResourceHandle	getVersionResourceByLabel(IResourceHandle versionHistoryHandle, java.lang.String label) Returns the resource handle of the version resource which is contained in the given version history and which is tagged by the given label.

Method Detail

getVersionHistoryCollections

public java.util.Set getVersionHistoryCollections(IResourceHandle vcrHandle)
                                           throws ResourceException

Returns a set of resource handles referring to the collections that are used to store version history resources for the given resource handle. The collections can be at the top of a whole tree in which version histories are stored. Several collections with version histories can be represented by their common ancestor collection.

Parameters:

vcrHandle - a resource handle referring to a vcr

Returns:

a set of resource handles of collections containing version histories

Throws:

ResourceException - if the resource handle is invalid or the operation failed

getVersionHistoryResource

public IResourceHandle getVersionHistoryResource(IResourceHandle resourceHandle)
                                          throws ResourceException

Returns a resource handle referring to the version history resource of the given vcr or version.

Parameters:

resourceHandle - a resource handle referring to a version resource or a vcr

Returns:

a resource handle referring to a version history resource

Throws:

ResourceException - if the resource handle is invalid or the operation failed

getRootVersion

public IResourceHandle getRootVersion(IResourceHandle versionHistoryHandle)
                               throws ResourceException

Returns a resource handle referring to the version resource that is the root of the given version history (i.e. the first version in the version history).

Parameters:

versionHistoryHandle - a resource handle referring to a version history resource

Returns:

a resource handle referring root version of the given version history

Throws:

ResourceException - if the resource handle is invalid or the operation failed

getVCRsBasedOnHistory

public java.util.Set getVCRsBasedOnHistory(IResourceHandle scope,
                                           IResourceHandle versionHistoryHandle)
                                    throws ResourceException

If the given resource handle refers to a version history resource, a list of resource handles referring to vcrs based on this version history will be returned. If a scope is specified, the result will contain only resource handles which are descendants of the collection referred by the given scope resource handle.

Parameters:

scope - the scope of the request (may be null)

versionHistoryHandle - a resource handle referring to a version history

Returns:

a set of resource handles referring to vcrs based on the given version history

Throws:

ResourceException - if the resource handle is invalid or the operation failed

getCheckedOutVCRsByVersion

public java.util.Set getCheckedOutVCRsByVersion(IResourceHandle versionHandle)
                                         throws ResourceException

If the given resource handle refers to a version resource, the set of resource handles referring to checked-out vcrs based on this version will be returned.

Parameters:

versionHandle - a resource handle referring to a version resource

Returns:

a set of resource handles of checked-out vcrs' based on the given version resource

Throws:

ResourceException - if the resource handle is invalid or the operation failed

getCheckInForkBehaviour

public java.util.Set getCheckInForkBehaviour(IResourceHandle versionHandle)
                                      throws ResourceException

Returns a set of IName objects describing the fork behavior of the given version resource on checkin. The return type is Set to ensure compatability with future extension of the DeltaV protocol. At the moment, there are three possibilities: forks may be explicitly allowed, they may be strictly forbidden or they may be discouraged, the latter meaning that the value of the forkOk parameter of the method IBasicVersioningManager.checkin() will decide in every case wether forks are allowed or not.

Parameters:

versionHandle - a resource handle referring to a version resource

Returns:

a set of IName objects describing the checkin-fork behaviour of the given version

Throws:

ResourceException - if the resource handle is invalid or the operation failed

See Also:

IVersionResource#getCheckInForkBehaviour

getCheckOutForkBehaviour

public java.util.Set getCheckOutForkBehaviour(IResourceHandle versionHandle)
                                       throws ResourceException

Returns a set of IName objects describing the fork behavior of the given version resource on checkout. The return type is Set to ensure compatability with future extension of the DeltaV protocol. At the moment, there are three possibilities: forks may be explicitly allowed, they may be strictly forbidden or they may be discouraged, the latter meaning that the value of the forkOk parameter of the method IBasicVersioningManager.checkout() will decide in every case wether forks are allowed or not.

Parameters:

versionHandle - a resource handle referring to a version resource

Returns:

a set of IName objects describing the checkout-fork behaviour of the given version

Throws:

ResourceException - if the resource handle is invalid or the operation failed

See Also:

IVersionResource#getCheckOutForkBehaviour

getAutoUpdateVcr

public IResourceHandle getAutoUpdateVcr(IResourceHandle workingResourceHandle)
                                 throws ResourceException

Returns a resource handle referring to the version controlled resource from which the given working resource was created and which will automatically be updated when the working resource is checked in. A working resource is a vcr which is created from a given version resource or vcr by a call to IMutableAdvancedVersioningManager.checkoutWorkingResource() , thus sharing it's version history with other vcrs. For further explanation, see IMutableAdvancedVersioningManager.checkoutWorkingResource() .

Parameters:

workingResourceHandle - a resource handle referring to a working resource.

Returns:

the resource handle of the vcr which will be updated when the given working resource is checked in (may be null)

Throws:

ResourceException - if the resource handle is invalid or the operation failed

getLabelSet

public java.util.Set getLabelSet(IResourceHandle versionHandle)
                          throws ResourceException

Returns a Set of strings representing the labels defined on the given version resource. A label is an client-defined identifier of a version which in unique in it's version history.

Parameters:

versionHandle - a resource handle referring to a version resource

Returns:

Set of String objects representing the labels defined on the given version resource

Throws:

ResourceException - if the resource handle is invalid or the operation failed

getVersionResourceByLabel

public IResourceHandle getVersionResourceByLabel(IResourceHandle versionHistoryHandle,
                                                 java.lang.String label)
                                          throws ResourceException

Returns the resource handle of the version resource which is contained in the given version history and which is tagged by the given label.

Parameters:

label - a version label

versionHistoryHandle - a resource handle referring to a version history

Returns:

a resource handle referring to the version with the given label in the given version history (may be null)

Throws:

ResourceException - if the resource handle is invalid or the operation failed