public interface IVersionResource
Copyright (c) SAP AG 2002-2004
Modifier and Type | Field and Description |
---|---|
static IName |
FORKBEHAVIOUR_DISCOURAGED
Forks are discouraged, and a checkin/checkout request must
specifically allow them.
|
static IName |
FORKBEHAVIOUR_FORBIDDEN
Forks are forbidden, and a checkin/checkout requests creating a fork will
be rejected.
|
Modifier and Type | Method and Description |
---|---|
void |
addLabel(String labelName)
Adds the given label if and only if it didn't exist before in the version's
version history.
|
ICheckOutInfo2 |
checkOut(boolean forkOk)
Checkout the version.
|
IResourceList |
getCheckedOutResources() |
IRidSet |
getCheckedOutRIDs() |
Set |
getCheckInForkBehaviour() |
Set |
getCheckOutForkBehaviour() |
Set |
getLabelSet() |
IResourceList |
getPredecessorResources() |
IRidSet |
getPredecessorRIDs() |
IResourceList |
getSuccessorResources() |
IRidSet |
getSuccessorRIDs() |
IResource |
getVersionHistoryResource() |
RID |
getVersionHistoryRID() |
void |
removeLabel(String labelName)
Removes the given label from the resource if present (removing non-existing
labels should be signaled through an exception)
|
void |
setLabel(String labelName)
Sets the given label on the version (removing it from other versions if
present)
|
static final IName FORKBEHAVIOUR_DISCOURAGED
static final IName FORKBEHAVIOUR_FORBIDDEN
ICheckOutInfo2 checkOut(boolean forkOk) throws ResourceException
forkOk
- set to true if it's ok to cause a fork in the
version history (may be rejected nevertheless if the checkout fork
behaviour dictates this).ResourceException
- Exception raised in failure situationIResourceList getCheckedOutResources() throws ResourceException
ResourceException
Set getCheckInForkBehaviour() throws ResourceException
ResourceException
- Exception raised in failure situationFORKBEHAVIOUR_DISCOURAGED
,
FORKBEHAVIOUR_FORBIDDEN
Set getCheckOutForkBehaviour() throws ResourceException
ResourceException
- Exception raised in failure situationFORKBEHAVIOUR_DISCOURAGED
,
FORKBEHAVIOUR_FORBIDDEN
IRidSet getCheckedOutRIDs() throws ResourceException
ResourceException
IResourceList getPredecessorResources() throws ResourceException
ResourceException
IRidSet getPredecessorRIDs() throws ResourceException
ResourceException
IResource getVersionHistoryResource() throws ResourceException
null
if
version history resources are not supported).ResourceException
RID getVersionHistoryRID() throws ResourceException
null
if version
history resources are not supported).ResourceException
IResourceList getSuccessorResources() throws ResourceException
ResourceException
IRidSet getSuccessorRIDs() throws ResourceException
ResourceException
void addLabel(String labelName) throws ResourceException
labelName
- labelResourceException
- Exception raised in failure situationvoid setLabel(String labelName) throws ResourceException
labelName
- labelResourceException
- Exception raised in failure situationvoid removeLabel(String labelName) throws ResourceException
labelName
- labelResourceException
- Exception raised in failure situationSet getLabelSet() throws ResourceException
ResourceException
- Exception raised in failure situationAccess 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