com.sap.netweaver.bc.rf.mi.version
Interface IBasicVersioningManager

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.mi_api.jar]

All Known Subinterfaces:

IMutableBasicVersioningManager

public interface IBasicVersioningManager

Read-Only interface describing a repository sub manager for basic versioning features. Essentially, these features offer the possibility to take a non-collection resource under version control with a linear version history (branches are considered an advanced feature). Additional features offered are autoversioning (meaning that a modification of a version controlled resource may automatically generate new versions) and auto version control (formerly referred to as 'enhanced collection feature', meaning that newly created non-collection resources are automatically taken under version control).

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 compatability with RFC3253 terminology).

Copyright (c) SAP AG 2003

Method Summary

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.
java.util.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.
java.util.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.
java.util.List	getVersionHistory(IResourceHandle resourceHandle) 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).
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	isVersionControlEnabled(IResourceHandle resourceHandle) Returns true if the given resource handle refers to a vcr.

Method Detail

isVersionControlEnabled

public boolean isVersionControlEnabled(IResourceHandle resourceHandle)
                                throws ResourceException

Returns true if the given resource handle refers to a vcr.

Parameters:

resourceHandle - a resource handle

Returns:

true if the given resource handle refers to a vcr.

Throws:

ResourceException - if the resource handle is invalid or the operation failed

getVersionHistory

public java.util.List getVersionHistory(IResourceHandle resourceHandle)
                                 throws ResourceException

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

Parameters:

resourceHandle - a resource handle

Returns:

list of all versions of this resource handle

Throws:

ResourceException - if the resource handle is invalid or the operation failed

getPredecessorVersions

public java.util.Set getPredecessorVersions(IResourceHandle resourceHandle)
                                     throws ResourceException

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. The return type is Set to ensure compatability 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.

Parameters:

resourceHandle - a resource handle

Returns:

set of immediate predecessor resource handles (may be empty)

Throws:

ResourceException - if the resource handle is invalid or the operation failed

getSuccessorVersions

public java.util.Set getSuccessorVersions(IResourceHandle resourceHandle)
                                   throws ResourceException

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. The return type is Set to ensure compatability 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.

Parameters:

resourceHandle - a resource handle

Returns:

set of immediate successor resource handles (may be empty)

Throws:

ResourceException - if the resource handle is invalid or the operation failed

isCheckedOut

public boolean isCheckedOut(IResourceHandle vcrHandle)
                     throws ResourceException

Returns true if the given resource handle refers to a checked-out vcr.

Parameters:

vcrHandle - a resource handle referring to a vcr

Returns:

true if the given resource handle refers to a checked-out vcr

Throws:

ResourceException - if the resource handle is invalid or the operation failed

getCheckedOutVersion

public IResourceHandle getCheckedOutVersion(IResourceHandle vcrHandle)
                                     throws ResourceException

Returns the version resource handle from which the given (checked-out) vcr has been checked out.

Parameters:

vcrHandle - a resource handle referring to a vcr

Returns:

the resource handle of the checked-out version of the given vcr (may be null)

Throws:

ResourceException - if the resource handle is invalid or the operation failed

getCheckedInVersion

public IResourceHandle getCheckedInVersion(IResourceHandle vcrHandle)
                                    throws ResourceException

Returns the version resource the given (checked-in) vcr is based on.

Parameters:

vcrHandle - a resource handle referring to a vcr

Returns:

the resource handle of the checked-in version of the given vcr (may be null)

Throws:

ResourceException - if the resource handle is invalid or the operation failed

isAutoChildVersionControlEnabled

public boolean isAutoChildVersionControlEnabled(IResourceHandle collectionHandle)
                                         throws ResourceException

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.

Parameters:

collectionHandle - a resource handle referring to a collection

Returns:

true if auto version control of children is enabled

Throws:

ResourceException - if the resource handle is invalid or the operation failed

getAutoVersioningMode

public IName getAutoVersioningMode(IResourceHandle versionedResourceHandle)
                            throws ResourceException

Returns the autoversioning mode of the vcr referred by the given resource handle. The autoversioning mode describes the way the server will handle implicit checkout/checkin of vcrs prior/subsequent to operations which are about to change the version controlled state of the vcr.

See IVersionControlledResource for possible modes.

Parameters:

versionedResourceHandle - a resource handle referring to a vcr

Returns:

IName of current autoversioning mode (may be null)

Throws:

ResourceException - if the resource handle is invalid or the operation failed