javax.jcr.version
Interface VersionHistory

All Superinterfaces:

Item, Node

public interface VersionHistory

extends Node

A VersionHistory object wraps an nt:versionHistory node. It provides convenient access to version history information.

Method Summary

void	addVersionLabel(java.lang.String versionName, java.lang.String label, boolean moveLabel) Adds the specified label to the specified version.
VersionIterator	getAllVersions() Returns an iterator over all the versions within this version history The order of the returned objects will not necessarily correspond to the order of versions in terms of the successor relation.
Version	getRootVersion() Returns the root version of this version history.
Version	getVersion(java.lang.String versionName) Retrieves a particular version from this version history by version name.
java.lang.String	getVersionableUUID() Returns the UUID of the versionable node for which this is the version history.
Version	getVersionByLabel(java.lang.String label) Retrieves a particular version from this version history by version label.
java.lang.String[]	getVersionLabels() Returns all version labels of the history or an empty array if there are none.
java.lang.String[]	getVersionLabels(Version version) Returns all version labels of the given version - empty array if none.
boolean	hasVersionLabel(java.lang.String label) Returns true if any version in the history has the given label.
boolean	hasVersionLabel(Version version, java.lang.String label) Returns true if the given version has the given label.
void	removeVersion(java.lang.String versionName) Removes the named version from this version history and automatically repairs the version graph.
void	removeVersionLabel(java.lang.String label) Removes the specified label from among the labels of this version history.

Methods inherited from interface javax.jcr.Node

addMixin, addNode, addNode, canAddMixin, cancelMerge, checkin, checkout, doneMerge, getBaseVersion, getCorrespondingNodePath, getDefinition, getIndex, getLock, getMixinNodeTypes, getNode, getNodes, getNodes, getPrimaryItem, getPrimaryNodeType, getProperties, getProperties, getProperty, getReferences, getUUID, getVersionHistory, hasNode, hasNodes, hasProperties, hasProperty, holdsLock, isCheckedOut, isLocked, isNodeType, lock, merge, orderBefore, removeMixin, restore, restore, restore, restoreByLabel, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, unlock, update

Methods inherited from interface javax.jcr.Item

accept, getAncestor, getDepth, getName, getParent, getPath, getSession, isModified, isNew, isNode, isSame, refresh, remove, save

Method Detail

getVersionableUUID

public java.lang.String getVersionableUUID()
                                    throws RepositoryException

Returns the UUID of the versionable node for which this is the version history.

Returns:

the UUID of the versionable node for which this is the version history.

Throws:

RepositoryException - if an error occurs.

getRootVersion

public Version getRootVersion()
                       throws RepositoryException

Returns the root version of this version history.

Returns:

a Version object.

Throws:

RepositoryException - if an error occurs.

getAllVersions

public VersionIterator getAllVersions()
                               throws RepositoryException

Returns an iterator over all the versions within this version history The order of the returned objects will not necessarily correspond to the order of versions in terms of the successor relation. To traverse the version graph one must traverse the jcr:successor REFERENCE properties starting with the root version. A version history will always have at least one version, the root version. Therefore, this method will always return an iterator of at least size 1.

Returns:

a VersionIterator object.

Throws:

RepositoryException - if an error occurs.

getVersion

public Version getVersion(java.lang.String versionName)
                   throws VersionException,
                          RepositoryException

Retrieves a particular version from this version history by version name.

Throws a VersionException if the specified version is not in this version history.

Parameters:

versionName - a version name

Returns:

a Version object.

Throws:

VersionException - if the specified version is not in this version history.

RepositoryException - if an error occurs.

getVersionByLabel

public Version getVersionByLabel(java.lang.String label)
                          throws RepositoryException

Retrieves a particular version from this version history by version label.

Throws a VersionException if the specified label is not in this version history.

Parameters:

label - a version label

Returns:

a Version object.

Throws:

VersionException - if the specified label is not in this version history.

RepositoryException - if an error occurs.

addVersionLabel

public void addVersionLabel(java.lang.String versionName,
                            java.lang.String label,
                            boolean moveLabel)
                     throws VersionException,
                            RepositoryException

Adds the specified label to the specified version. This corresponds to adding a value to the jcr:versionLabels multi-value property of the nt:version node that represents the specified version.

Note that this change is made immediately; there is no need to call save. In fact, since the the version storage is read-only with respect to normal repository methods, save does not even function in this context.

Within a particular version history, a given label may appear a maximum of once. If the specified label is already assigned to a version in this history and moveLabel is true then the label is removed from its current location and added to the version with the specified versionName. If moveLabel is false, then an attempt to add a label that already exists in this version history will throw a VersionException.

A VersionException is also thrown if the named version is not in this VersionHistory or if it is the root version (jcr:rootVersion) or if the label specified is not a valid JCR NAME.

Parameters:

versionName - the name of the version to which the label is to be added.

label - the label to be added.

moveLabel - if true, then if label is already assigned to a version in this version history, it is moved to the new version specified; if false, then attempting to assign an already used label will throw a VersionException.

Throws:

VersionException - if an attempt is made to add an existing label to a version history and moveLabel is false or if the specifed version does not exist in this version history or if the specified version is the root version (jcr:rootVersion).

RepositoryException - if another error occurs.

removeVersionLabel

public void removeVersionLabel(java.lang.String label)
                        throws VersionException,
                               RepositoryException

Removes the specified label from among the labels of this version history. This corresponds to removing a property from the jcr:versionLabels child node of the nt:versionHistory node that represents this version history.

Note that this change is made immediately; there is no need to call save. In fact, since the the version storage is read-only with respect to normal repository methods, save does not even function in this context.

If a label is specified that does not exist in this version history, a VersionException is thrown.

Parameters:

label - a version label

Throws:

VersionException - if the name labvel does not exist in this version history.

RepositoryException - if another error occurs.

hasVersionLabel

public boolean hasVersionLabel(java.lang.String label)
                        throws RepositoryException

Returns true if any version in the history has the given label.

Parameters:

label - a version label

Returns:

a boolean.

Throws:

RepositoryException - if an error occurs.

hasVersionLabel

public boolean hasVersionLabel(Version version,
                               java.lang.String label)
                        throws VersionException,
                               RepositoryException

Returns true if the given version has the given label.

Parameters:

version - a Version object

label - a version label

Returns:

a boolean.

Throws:

VersionException - if the specified version is not of this version history.

RepositoryException - if another error occurs.

getVersionLabels

public java.lang.String[] getVersionLabels()
                                    throws RepositoryException

Returns all version labels of the history or an empty array if there are none.

Returns:

a String array containing all the labels of the version history.

Throws:

RepositoryException - if an error occurs.

getVersionLabels

public java.lang.String[] getVersionLabels(Version version)
                                    throws VersionException,
                                           RepositoryException

Returns all version labels of the given version - empty array if none. Throws a VersionException if the specified version is not in this version history.

Parameters:

version -

Returns:

a String array containing all the labels of the given version

Throws:

VersionException - if the specified version is not in this version history.

RepositoryException - if another error occurs.

removeVersion

public void removeVersion(java.lang.String versionName)
                   throws ReferentialIntegrityException,
                          AccessDeniedException,
                          UnsupportedRepositoryOperationException,
                          VersionException,
                          RepositoryException

Removes the named version from this version history and automatically repairs the version graph. If the version to be removed is V, V's predecessor set is P and V's successor set is S, then the version graph is repaired s follows:

• For each member of P, remove the reference to V from its successor list and add references to each member of S.
• For each member of S, remove the reference to V from its predecessor list and add references to each member of P.

Note that this change is made immediately; there is no need to call save. In fact, since the the version storage is read-only with respect to normal repository methods, save does not even function in this context.

A ReferentialIntegrityException will be thrown if the specified version is currently the target of a REFERENCE property elsewhere in the repository (not just in this workspace) and the current Session has read access to that REFERENCE property.

An AccessDeniedException will be thrown if the current Session does not have permission to remove the specified version or if the specified version is currently the target of a REFERENCE property elsewhere in the repository (not just in this workspace) and the current Session does not have read access to that REFERENCE property.

Throws an UnsupportedRepositoryOperationException if this operation is not supported by the implementation.

Throws a VersionException if the named version is not in this VersionHistory.

Parameters:

versionName - the name of a version in this version history.

Throws:

ReferentialIntegrityException - if the specified version is currently the target of a REFERENCE property elsewhere in the repository (not necessarily in this workspace) and the current Session has read access to that REFERENCE property.

AccessDeniedException - if the current Session does not have permission to remove the specified version or if the specified version is currently the target of a REFERENCE property elsewhere in the repository (not just in this workspace) and the current Session does not have read access to that REFERENCE property.

UnsupportedRepositoryOperationException - if this operation is not supported by the implementation.

VersionException - if the named version is not in this version history.

RepositoryException - if another error occurs.