public interface IMutableBasicVersioningManager extends IBasicVersioningManager
Copyright (c) SAP AG 2003
Modifier and Type | Method and Description |
---|---|
ICheckInInfo |
checkIn(IResourceHandle resourceHandle,
IRid expectedCheckInRID,
boolean forkOk,
boolean keepCheckedOut)
Check in a checked-out vcr to create a new version describing the current
version controlled state of the vcr.
|
ICheckOutInfo |
checkOutInPlace(IResourceHandle vcrHandle,
boolean forkOk)
Check out a checked-in vcr to prepare subsequent changes of it's version
controlled state.
|
Set |
setAutoChildVersionControlEnabled(IResourceHandle collectionHandle,
boolean modifyPlainChildren,
boolean returnModified,
boolean enable)
Enables or disables auto child version controlling for the collection
referred by the given collection handle.
|
void |
setVersionControlEnabled(IResourceHandle resourceHandle,
boolean enabled)
Enables or disables version control for the resource referred by the given
resource handle.
|
Set |
undoCheckOut(IResourceHandle vcrHandle)
Roll back a previous checkout operation.
|
Set |
updateFromVersion(IResourceHandle vcrHandle,
IResourceHandle versionHandle)
The version controlled state of the checked-in vcr referred by the given
vcrHandle parameter will be updated from the state of the version referred
by the given versionHandle, and this version will become the new checked-in
version of the vcr.
|
getAutoVersioningMode, getCheckedInVersion, getCheckedOutVersion, getPredecessorVersions, getSuccessorVersions, getVersionHistory, getVersionID, getVersionResources, isAutoChildVersionControlEnabled, isCheckedOut, isVersion, isVersionControlEnabled
void setVersionControlEnabled(IResourceHandle resourceHandle, boolean enabled) throws ResourceException
resourceHandle
- a resource handleenabled
- true if versioning is to be enabledResourceException
- if the resource handle is invalid or the
operation failedICheckOutInfo checkOutInPlace(IResourceHandle vcrHandle, boolean forkOk) throws ResourceException
The forkOk parameter must be ignored if the server does not support the
interface IAdvancedVersioningManager
, in which case forks
are disallowed anyway. Otherwise, the semantics of this parameter depends
on the fork behaviour of the checked-in version of the given vcr (see
IAdvancedVersioningManager.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.
vcrHandle
- the resource handle of a checked-in vcrforkOk
- allow forks in version history upon check inResourceException
- if the resource handle is invalid or the
operation failedSet undoCheckOut(IResourceHandle vcrHandle) throws ResourceException
The method returns a set of handles of the resources modified by the operation, which is not trivial in the case of a more advanced versioning manager supporting version controlled collections.
vcrHandle
- the resource handle of a checked-out vcrResourceException
- if the resource handle is invalid or the
operation failedICheckInInfo checkIn(IResourceHandle resourceHandle, IRid expectedCheckInRID, boolean forkOk, boolean keepCheckedOut) throws ResourceException
The state of the new version will be initialized from the current state of the given resource, where 'state' is defined to consist of content, dead properties and - in the case of a version controlled collection - the set of version controlled bindings of the collection together with ordering information.
If an expected checkin RID is provided, the method may fail if the server cannot assign this RID to the new version.
The forkOk parameter must be ignored if the server does not support the
interface IAdvancedVersioningManager
, in which case forks
are disallowed anyway. Otherwise, the semantics of this parameter depends
on the fork behaviour of the checked-out version of the given vcr (see
IAdvancedVersioningManager.getCheckInForkBehaviour
): If forks
are strictly allowed or forbidden (as stated by getCheckInForkBehaviour()),
the parameter must be ignored. Otherwise, if forkOk is false and the
checkin created a branched version history, the method must fail.
expectedCheckInRID
- the expected RID of the new version (may be null)forkOk
- allow a new fork in the version historykeepCheckedOut
- if true, the given vcr will be checked out immediately
after the checkin succeeded
param resourceHandle parameterResourceException
- if the resource handle is invalid or the
operation failedSet updateFromVersion(IResourceHandle vcrHandle, IResourceHandle versionHandle) throws ResourceException
The method returns a set of handles of the resources modified by the operation, is be not trivial in the case of a more advanced versioning manager supporting version controlled collections.
vcrHandle
- the resource handle of a checked-out vcrversionHandle
- the resource handle of a version of the vcr referred by
vcrHandleResourceException
- if the resource handle is invalid or the
operation failedSet setAutoChildVersionControlEnabled(IResourceHandle collectionHandle, boolean modifyPlainChildren, boolean returnModified, boolean enable) throws ResourceException
modifyPlainChildren
is true, then any existing plain child resource
will be put under version control. modifyPlainChildren
is true, then any existing versioned
plain child resource will be released from version control. For performance reasons, the caller should set the parameter returnModified to false, if possible.
collectionHandle
- a resource handle referring to a collectionmodifyPlainChildren
- if true all direct plain children will be put
under version controlreturnModified
- if false, an empty Set may be returnedenable
- true if auto child versioning is to be enabledResourceException
- 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