Package org.alfresco.service.cmr.version

Interface VersionHistory

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

VersionHistoryImpl, VirtualVersionServiceExtension.VirtualVersionHistory

@AlfrescoPublicApi
public interface VersionHistory
extends java.io.Serializable

Version history interface. Collects the versions that make-up a version history.

Author:

Roy Wetherall

Method Summary

Modifier and Type	Method	Description
java.util.Collection<Version>	getAllVersions()	Gets a collection containing all the versions within the version history.
Version	getHeadVersion()	Gets the head (current / most recent) version of the version history.
Version	getPredecessor(Version version)	Gets the predecessor of a specified version
Version	getRootVersion()	Gets the root (initial / least recent) version of the version history.
java.util.Collection<Version>	getSuccessors(Version version)	Gets the succeeding versions of a specified version.
Version	getVersion(java.lang.String versionLabel)	Gets a version with a specified version label.

Method Detail

getRootVersion

Version getRootVersion()

Gets the root (initial / least recent) version of the version history.

Returns:

the root version

getHeadVersion

Version getHeadVersion()

Gets the head (current / most recent) version of the version history.

Returns:

the root version

getAllVersions

java.util.Collection<Version> getAllVersions()

Gets a collection containing all the versions within the version history.

Versions are returned in descending create date order (most recent first).

Returns:

collection containing all the versions

getPredecessor

Version getPredecessor(Version version)

Gets the predecessor of a specified version

Parameters:

version - the version object

Returns:

the predeceeding version, null if root version

getSuccessors

java.util.Collection<Version> getSuccessors(Version version)

Gets the succeeding versions of a specified version.

Parameters:

version - the version object

Returns:

a collection containing the succeeding version, empty is none

getVersion

Version getVersion(java.lang.String versionLabel)

Gets a version with a specified version label. The version label is guarenteed unique within the version history.

Parameters:

versionLabel - the version label

Returns:

the version object

Throws:

VersionDoesNotExistException - indicates requested version does not exisit