public interface IAdvancedVersioningManager
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).Modifier and Type | Method and Description |
---|---|
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.
|
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.
|
Set |
getCheckInForkBehaviour(IResourceHandle versionHandle)
Returns a set of
IName objects describing the fork behaviour of
the given version resource on checkin. |
Set |
getCheckOutForkBehaviour(IResourceHandle versionHandle)
Returns a set of
IName objects describing the fork behaviour of
the given version resource on checkout. |
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).
|
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.
|
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,
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.
|
Set getVersionHistoryCollections(IResourceHandle vcrHandle) throws ResourceException
vcrHandle
- a resource handle referring to a vcrResourceException
- if the resource handle is invalid or the
operation failedIResourceHandle getVersionHistoryResource(IResourceHandle resourceHandle) throws ResourceException
resourceHandle
- a resource handle referring to a version resource or
a vcrResourceException
- if the resource handle is invalid or the
operation failedIResourceHandle getRootVersion(IResourceHandle versionHistoryHandle) throws ResourceException
versionHistoryHandle
- a resource handle referring to a version
history resourceResourceException
- if the resource handle is invalid or the
operation failedSet getVCRsBasedOnHistory(IResourceHandle scope, IResourceHandle versionHistoryHandle) throws ResourceException
scope
- the scope of the request (may be null)versionHistoryHandle
- a resource handle referring to a version
historyResourceException
- if the resource handle is invalid or the
operation failedSet getCheckedOutVCRsByVersion(IResourceHandle versionHandle) throws ResourceException
versionHandle
- a resource handle referring to a version resourceResourceException
- if the resource handle is invalid or the
operation failedSet getCheckInForkBehaviour(IResourceHandle versionHandle) throws ResourceException
IName
objects describing the fork behaviour of
the given version resource on checkin. The return type is Set
to ensure compatibility 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 whether
forks are allowed or not.versionHandle
- a resource handle referring to a version resourceIName
objects describing the checkin-fork
behaviour of the given versionResourceException
- if the resource handle is invalid or the
operation failedIVersionResource.getCheckInForkBehaviour()
Set getCheckOutForkBehaviour(IResourceHandle versionHandle) throws ResourceException
IName
objects describing the fork behaviour of
the given version resource on checkout. The return type is Set
to ensure compatibility 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 whether
forks are allowed or not.versionHandle
- a resource handle referring to a version resourceIName
objects describing the checkout-fork
behaviour of the given versionResourceException
- if the resource handle is invalid or the
operation failedIVersionResource.getCheckOutForkBehaviour()
IResourceHandle getAutoUpdateVcr(IResourceHandle workingResourceHandle) throws ResourceException
IMutableAdvancedVersioningManager.checkoutWorkingResource()
,
thus sharing it's version history with other vcrs. For further explanation,
see IMutableAdvancedVersioningManager.checkoutWorkingResource()
.workingResourceHandle
- a resource handle referring to a working
resource.ResourceException
- if the resource handle is invalid or the
operation failedSet getLabelSet(IResourceHandle versionHandle) throws ResourceException
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.versionHandle
- a resource handle referring to a version resourceSet
of String
objects representing the
labels defined on the given version resourceResourceException
- if the resource handle is invalid or the
operation failedIResourceHandle getVersionResourceByLabel(IResourceHandle versionHistoryHandle, String label) throws ResourceException
label
- a version labelversionHistoryHandle
- a resource handle referring to a version
historyResourceException
- if the resource handle is invalid or the
operation failedAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice