Package org.alfresco.service.cmr.version

Interface VersionHistory

All Superinterfaces:
Serializable
All Known Implementing Classes:
VersionHistoryImpl, VirtualVersionServiceExtension.VirtualVersionHistory
@AlfrescoPublicApi public interface VersionHistory extends Serializable
Version history interface. Collects the versions that make-up a version history.
Author:
Roy Wetherall

  • Method Details

    • 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

      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

    • getTotalVersionsCount

      int getTotalVersionsCount()
      Represents the total number of versions available in the entire version history, not just the number of versions loaded in the current page (if pagination is used).
      Returns:
      the total number of versions in the database

    • 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

      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(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