com.sapportals.wcm.repository

Interface IVersionResource

public interface IVersionResource

Interface for version (revision) resources (see RFC3253 ).

Copyright (c) SAP AG 2002-2004

Field Summary

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.

Method Summary

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)

Field Detail

FORKBEHAVIOUR_DISCOURAGED

static final IName FORKBEHAVIOUR_DISCOURAGED

Forks are discouraged, and a checkin/checkout request must specifically allow them.

FORKBEHAVIOUR_FORBIDDEN

static final IName FORKBEHAVIOUR_FORBIDDEN

Forks are forbidden, and a checkin/checkout requests creating a fork will be rejected.

Method Detail

checkOut

ICheckOutInfo2 checkOut(boolean forkOk)
                        throws ResourceException

Checkout the version.

Parameters:

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).

Returns:

information about chechkout result

Throws:

ResourceException - Exception raised in failure situation

getCheckedOutResources

IResourceList getCheckedOutResources()
                                     throws ResourceException

Returns:

set of current checkouts of this version

Throws:

ResourceException

getCheckInForkBehaviour

Set getCheckInForkBehaviour()
                            throws ResourceException

Returns:

a set of INames describing the checkout-in behaviour for this resource.

Throws:

ResourceException - Exception raised in failure situation

See Also:

FORKBEHAVIOUR_DISCOURAGED, FORKBEHAVIOUR_FORBIDDEN

getCheckOutForkBehaviour

Set getCheckOutForkBehaviour()
                             throws ResourceException

Returns:

a set of INames describing the checkout-fork behaviour for this resource.

Throws:

ResourceException - Exception raised in failure situation

See Also:

FORKBEHAVIOUR_DISCOURAGED, FORKBEHAVIOUR_FORBIDDEN

getCheckedOutRIDs

IRidSet getCheckedOutRIDs()
                          throws ResourceException

Returns:

set of current checkouts of this version

Throws:

ResourceException

getPredecessorResources

IResourceList getPredecessorResources()
                                      throws ResourceException

Returns:

set of immediate predecessors if this version

Throws:

ResourceException

getPredecessorRIDs

IRidSet getPredecessorRIDs()
                           throws ResourceException

Returns:

set of immediate predecessors if this version

Throws:

ResourceException

getVersionHistoryResource

IResource getVersionHistoryResource()
                                    throws ResourceException

Returns:

IResource for version history resource (or null if version history resources are not supported).

Throws:

ResourceException

getVersionHistoryRID

RID getVersionHistoryRID()
                         throws ResourceException

Returns:

RID of version history resource (or null if version history resources are not supported).

Throws:

ResourceException

getSuccessorResources

IResourceList getSuccessorResources()
                                    throws ResourceException

Returns:

set of immediate successors of this version

Throws:

ResourceException

getSuccessorRIDs

IRidSet getSuccessorRIDs()
                         throws ResourceException

Returns:

set of immediate successors of this version

Throws:

ResourceException

addLabel

void addLabel(String labelName)
              throws ResourceException

Adds the given label if and only if it didn't exist before in the version's version history.

Parameters:

labelName - label

Throws:

ResourceException - Exception raised in failure situation

setLabel

void setLabel(String labelName)
              throws ResourceException

Sets the given label on the version (removing it from other versions if present)

Parameters:

labelName - label

Throws:

ResourceException - Exception raised in failure situation

removeLabel

void removeLabel(String labelName)
                 throws ResourceException

Removes the given label from the resource if present (removing non-existing labels should be signaled through an exception)

Parameters:

labelName - label

Throws:

ResourceException - Exception raised in failure situation

getLabelSet

Set getLabelSet()
                throws ResourceException

Returns:

set of labels present on this version (empty list when no labels present).

Throws:

ResourceException - Exception raised in failure situation

Access Rights

This class can be accessed from:

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