org.apache.jackrabbit.core.version
Interface InternalVersionHistory

All Superinterfaces:
InternalVersionItem

public interface InternalVersionHistory
extends InternalVersionItem

This interface defines the internal version history.


Method Summary
 int getNumVersions()
          Returns the number of versions in this version history.
 InternalVersion getRootVersion()
          Equivalalent to VersionHistory.getRootVersion().
 InternalVersion getVersion(Name versionName)
          Equivalent to VersionHistory.getVersion(java.lang.String).
 InternalVersion getVersion(NodeId id)
          Returns the version with the given uuid or null if the respective version does not exist.
 NodeId getVersionableId()
          Returns the id of the versionable node that this history belongs to.
 InternalVersion getVersionByLabel(Name label)
          Equivalalent to VersionHistory.getVersionByLabel(java.lang.String) but returns null if the version does not exists.
 Name[] getVersionLabels()
          Returns a name array of all version labels that exist in this version history
 NodeId getVersionLabelsId()
          Returns the Id of the version labels node.
 Name[] getVersionNames()
          Returns a name array of all version names that exist in this version history.
 boolean hasVersion(Name versionName)
          Checks if the version with the given name exists in this version history.
 
Methods inherited from interface org.apache.jackrabbit.core.version.InternalVersionItem
getId, getParent
 

Method Detail

getRootVersion

InternalVersion getRootVersion()
Equivalalent to VersionHistory.getRootVersion().

Returns:
the root version
See Also:
VersionHistory.getRootVersion()

getVersion

InternalVersion getVersion(Name versionName)
                           throws VersionException
Equivalent to VersionHistory.getVersion(java.lang.String).

Parameters:
versionName - the name of the version
Returns:
the version
Throws:
VersionException - if the version does not exist
See Also:
VersionHistory.getVersion(java.lang.String)

hasVersion

boolean hasVersion(Name versionName)
Checks if the version with the given name exists in this version history.

Parameters:
versionName - the name of the version
Returns:
true if the version exists; false otherwise.

getVersion

InternalVersion getVersion(NodeId id)
Returns the version with the given uuid or null if the respective version does not exist.

Parameters:
id - the id of the version
Returns:
the internal version ot null

getVersionByLabel

InternalVersion getVersionByLabel(Name label)
Equivalalent to VersionHistory.getVersionByLabel(java.lang.String) but returns null if the version does not exists.

Parameters:
label - the lable
Returns:
the version or null if not exists
See Also:
VersionHistory.getVersionByLabel(java.lang.String)

getNumVersions

int getNumVersions()
Returns the number of versions in this version history.

Returns:
the number of versions, including the root version.

getVersionableId

NodeId getVersionableId()
Returns the id of the versionable node that this history belongs to.

Returns:
the id of the versionable node.

getVersionLabels

Name[] getVersionLabels()
Returns a name array of all version labels that exist in this version history

Returns:
the labels

getVersionNames

Name[] getVersionNames()
Returns a name array of all version names that exist in this version history.

Returns:
the names

getVersionLabelsId

NodeId getVersionLabelsId()
Returns the Id of the version labels node.

Returns:
the id of the version labels node.


Copyright © 2004-2010 The Apache Software Foundation. All Rights Reserved.