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

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

All Superinterfaces:

IAdvancedVersioningManager

public interface IMutableAdvancedVersioningManager

extends IAdvancedVersioningManager

Interface describing the write methods of a repository sub manager for the advanced versioning features described in IAdvancedVersioningManager . For an explanation of terminological conventions, please see IBasicVersioningMananger.

Method Summary

void	addLabel(IResourceHandle versionHandle, java.lang.String label) Tags the given version resource with the given label.
ICheckOutInfo	checkOutWorkingResource(IResourceHandle resourceHandle, boolean applyToVersion, boolean forkOk) If the given resource handle refers to a vcr or a version resource, this resource is checked out to create a new working resource, which is essentially a new vcr with a server-provided RID, based on the given version (resp. the checked-in version of the given vcr) and using the same version history.
void	removeLabel(IResourceHandle versionHandle, java.lang.String label) Removes the given label from the given version resource, if it is present there.
void	setLabel(IResourceHandle versionHandle, java.lang.String label) Tags the given version resource with the given label.

Methods inherited from interface com.sap.netweaver.bc.rf.mi.version.IAdvancedVersioningManager

getAutoUpdateVcr, getCheckedOutVCRsByVersion, getCheckInForkBehaviour, getCheckOutForkBehaviour, getLabelSet, getRootVersion, getVCRsBasedOnHistory, getVersionHistoryCollections, getVersionHistoryResource, getVersionResourceByLabel

Method Detail

checkOutWorkingResource

public ICheckOutInfo checkOutWorkingResource(IResourceHandle resourceHandle,
                                             boolean applyToVersion,
                                             boolean forkOk)
                                      throws ResourceException

If the given resource handle refers to a vcr or a version resource, this resource is checked out to create a new working resource, which is essentially a new vcr with a server-provided RID, based on the given version (resp. the checked-in version of the given vcr) and using the same version history.

Checking out a vcr is roughly equivalent to a checkout of it's checked-in version, with the following additional feature: when the newly created working resource will be checked in, the given vcr will automatically be updated from the newly created version.

The semantics of the forkOk parameter depends on the fork behaviour of the given (checked-in) version (see getCheckOutForkBehaviour() ): If forks are strictly allowed or forbidden (as stated by getCheckOutForkBehaviour()), the parameter must be ignored. Otherwise, if forkOk is false and the server expects a subsequent checkin to create a branched version history, the method must fail.

Parameters:

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

applyToVersion - checkout the checked-in version of the given vcr rather than the vcr itself

forkOk - allow subsequent forks in version history upon check in

Returns:

ICheckOutInfo object containing information about the results of the checkout process

Throws:

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

removeLabel

public void removeLabel(IResourceHandle versionHandle,
                        java.lang.String label)
                 throws ResourceException

Removes the given label from the given version resource, if it is present there.

Parameters:

versionHandle - a resource handle referring to a version resource

label - the label to remove

Throws:

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

setLabel

public void setLabel(IResourceHandle versionHandle,
                     java.lang.String label)
              throws ResourceException

Tags the given version resource with the given label. If the label is already present on another version in the same version history, the label is removed from this latter version.

Parameters:

versionHandle - a resource handle referring to a version resource

label - the label to set

Throws:

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

addLabel

public void addLabel(IResourceHandle versionHandle,
                     java.lang.String label)
              throws ResourceException

Tags the given version resource with the given label. If the label is already present on another version in the same version history, the method must fail .

Parameters:

versionHandle - a version resource handle

label - the label to add

Throws:

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