public interface IBasicVersioningManager
Throughout the documentation of this class, the following terminological conventions are used:
the term 'vcr' is used instead of 'version controlled resource', meaning a resource with an associated set of version resources (the version history). The state of the vcr that is stored in it's version resource is called the 'version controlled state' of the resource. At least, the version controlled state contains the content and the dead properties of the vcr.
A vcr is always in exactly one of two possible states, namely 'checked-in' and 'checked-out'. If the resource is checked-in, all operations are forbidden that would change the version controlled state (but be aware of the autoversioning feature, which may force implicit check-outs).
When a vcr changes it's state from checked-in to checked-out, a version resource is associated with this state change, describing the current version controlled state of the vcr and called the 'checked-out version' of the checked-out vcr.
Similarly, a checked-in vcr is associated with a version resource, describing it's version controlled state and called the 'checked-in version' of the checked-in vcr.
The checked-in version (resp. checked-out version) of the vcr may be thought of as the 'current' version of the vcr (but this terminology is avoided for Compatibility with RFC3253 terminology).
Copyright (c) SAP AG 2003
Modifier and Type | Method and Description |
---|---|
IName |
getAutoVersioningMode(IResourceHandle versionedResourceHandle)
Returns the autoversioning mode of the vcr referred by the given resource
handle.
|
IResourceHandle |
getCheckedInVersion(IResourceHandle vcrHandle)
Returns the version resource the given (checked-in) vcr is based on.
|
IResourceHandle |
getCheckedOutVersion(IResourceHandle vcrHandle)
Returns the version resource handle from which the given (checked-out) vcr
has been checked out.
|
Set |
getPredecessorVersions(IResourceHandle resourceHandle)
If the given resource handle refers to a version resource, the method will
return the set of resource handles which refer to immediate predecessors of
that version in it's version history.
|
Set |
getSuccessorVersions(IResourceHandle resourceHandle)
If the given resource handle refers to a version resource, the method will
return the set of resource handles which refer to immediate successors of
that version in it's version history.
|
List |
getVersionHistory(IResourceHandle vcrHandle)
If the given resource handle refers to a vcr with a linear version history,
this version history is returned as a list of resource handles referring to
version resources (note that the last version in the list is the newest).
|
String |
getVersionID(IResourceHandle versionHandle)
Returns the identifier for this version resource.
|
Set |
getVersionResources(IResourceHandle vhrHandle)
Returns a set of resource handles to the versions in the given version history
|
boolean |
isAutoChildVersionControlEnabled(IResourceHandle collectionHandle)
Returns true if auto version control of children is enabled for the
collection resource referred by the given collection handle, which means
that newly created direct non-collection children will automatically put
under version control.
|
boolean |
isCheckedOut(IResourceHandle vcrHandle)
Returns true if the given resource handle refers to a checked-out vcr.
|
boolean |
isVersion(IResourceHandle resourceHandle)
Returns true if the given resource handle refers to a version of a vcr.
|
boolean |
isVersionControlEnabled(IResourceHandle resourceHandle)
Returns true if the given resource handle refers to a vcr.
|
boolean isVersionControlEnabled(IResourceHandle resourceHandle) throws ResourceException
resourceHandle
- a resource handleResourceException
- if the resource handle is invalid or the
operation failedboolean isVersion(IResourceHandle resourceHandle) throws ResourceException
resourceHandle
- a resource handleResourceException
- if the resource handle is invalid or the
operation failedString getVersionID(IResourceHandle versionHandle) throws ResourceException
null
.versionHandle
- parameterResourceException
- if the resource handle is invalid or the
operation failedList getVersionHistory(IResourceHandle vcrHandle) throws ResourceException
vcrHandle
- a resource handleResourceException
- if the resource handle is invalid or the
operation failedSet getVersionResources(IResourceHandle vhrHandle) throws ResourceException
vhrHandle
- the resource handle to a version history resourceResourceException
- if the resource handle is invalid or the
operation failsSet getPredecessorVersions(IResourceHandle resourceHandle) throws ResourceException
Set
to ensure compatibility with more advanced versioning managers that may
allow non-linear version histories. If the given resource handle refers to a checked-out vcr, the above semantics is applied to the vcr's checked-out version.
resourceHandle
- a resource handleResourceException
- if the resource handle is invalid or the
operation failedSet getSuccessorVersions(IResourceHandle resourceHandle) throws ResourceException
Set
to ensure compatibility with more advanced versioning managers that may
allow non-linear version histories. If the given resource handle refers to a checked-out vcr, the above semantics is applied to the vcr's checked-out version.
resourceHandle
- a resource handleResourceException
- if the resource handle is invalid or the
operation failedboolean isCheckedOut(IResourceHandle vcrHandle) throws ResourceException
vcrHandle
- a resource handle referring to a vcrResourceException
- if the resource handle is invalid or the
operation failedIResourceHandle getCheckedOutVersion(IResourceHandle vcrHandle) throws ResourceException
vcrHandle
- a resource handle referring to a vcrResourceException
- if the resource handle is invalid or the
operation failedIResourceHandle getCheckedInVersion(IResourceHandle vcrHandle) throws ResourceException
vcrHandle
- a resource handle referring to a vcrResourceException
- if the resource handle is invalid or the
operation failedboolean isAutoChildVersionControlEnabled(IResourceHandle collectionHandle) throws ResourceException
collectionHandle
- a resource handle referring to a collectionResourceException
- if the resource handle is invalid or the
operation failedIName getAutoVersioningMode(IResourceHandle versionedResourceHandle) throws ResourceException
See IVersionControlledResource
for possible modes.
versionedResourceHandle
- a resource handle referring to a vcrResourceException
- 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