org.apache.jackrabbit.jcr2spi.version
Interface VersionManager

All Known Implementing Classes:

VersionManagerImpl

public interface VersionManager

VersionManager...

Method Summary

void	addVersionLabel(NodeState versionHistoryState, NodeState versionState, Name qLabel, boolean moveLabel)
NodeEntry	checkin(NodeState nodeState)
void	checkIsCheckedOut(NodeState nodeState)
void	checkout(NodeState nodeState)
void	checkout(NodeState nodeState, NodeId activityId)
NodeEntry	checkpoint(NodeState nodeState)
NodeEntry	checkpoint(NodeState nodeState, NodeId activityId)
NodeEntry	createActivity(String title)
NodeEntry	createConfiguration(NodeState nodeState)
NodeEntry	getVersionableNodeEntry(NodeState versionState)
NodeEntry	getVersionHistoryEntry(NodeState versionableState)
boolean	isCheckedOut(NodeState nodeState)
Iterator<NodeId>	merge(NodeState nodeState, String workspaceName, boolean bestEffort)
Iterator<NodeId>	merge(NodeState nodeState, String workspaceName, boolean bestEffort, boolean isShallow)
Iterator<NodeId>	mergeActivity(NodeState activityState)
void	removeActivity(NodeState activityState)
void	removeVersion(NodeState versionHistoryState, NodeState versionState)
void	removeVersionLabel(NodeState versionHistoryState, NodeState versionState, Name qLabel)
void	resolveMergeConflict(NodeState nodeState, NodeState versionState, boolean done)
void	restore(NodeState[] versionStates, boolean removeExisting)
void	restore(NodeState nodeState, Path relativePath, NodeState versionState, boolean removeExisting)

Method Detail

checkin

NodeEntry checkin(NodeState nodeState)
                  throws VersionException,
                         UnsupportedRepositoryOperationException,
                         InvalidItemStateException,
                         LockException,
                         RepositoryException

Parameters:

nodeState -

Returns:

NodeEntry of newly created version

Throws:

VersionException

UnsupportedRepositoryOperationException

InvalidItemStateException

LockException

RepositoryException

See Also:

Node.checkin()

checkout

void checkout(NodeState nodeState)
              throws UnsupportedRepositoryOperationException,
                     LockException,
                     RepositoryException

Parameters:

nodeState -

Throws:

UnsupportedRepositoryOperationException

LockException

RepositoryException

See Also:

Node.checkout()

checkout

void checkout(NodeState nodeState,
              NodeId activityId)
              throws RepositoryException

Parameters:

nodeState -

activityId -

Throws:

RepositoryException

checkpoint

NodeEntry checkpoint(NodeState nodeState)
                     throws RepositoryException

Parameters:

nodeState -

Throws:

RepositoryException

See Also:

VersionManager.checkpoint(String)

checkpoint

NodeEntry checkpoint(NodeState nodeState,
                     NodeId activityId)
                     throws RepositoryException

Parameters:

nodeState -

Throws:

RepositoryException

See Also:

VersionManager.checkpoint(String)

isCheckedOut

boolean isCheckedOut(NodeState nodeState)
                     throws RepositoryException

Parameters:

nodeState -

Returns:

Throws:

RepositoryException

See Also:

Node.isCheckedOut()

checkIsCheckedOut

void checkIsCheckedOut(NodeState nodeState)
                       throws VersionException,
                              RepositoryException

Parameters:

nodeState -

Throws:

VersionException - If the Node represented by the given NodeState is checkedin.

RepositoryException - If another error occurs.

See Also:

Node.isCheckedOut()

removeVersion

void removeVersion(NodeState versionHistoryState,
                   NodeState versionState)
                   throws ReferentialIntegrityException,
                          AccessDeniedException,
                          UnsupportedRepositoryOperationException,
                          VersionException,
                          RepositoryException

Parameters:

versionHistoryState -

versionState -

Throws:

ReferentialIntegrityException

AccessDeniedException

UnsupportedRepositoryOperationException

VersionException

RepositoryException

See Also:

VersionHistory.removeVersion(String)

addVersionLabel

void addVersionLabel(NodeState versionHistoryState,
                     NodeState versionState,
                     Name qLabel,
                     boolean moveLabel)
                     throws VersionException,
                            RepositoryException

Parameters:

versionHistoryState -

versionState -

qLabel -

moveLabel -

Throws:

VersionException

RepositoryException

See Also:

VersionHistory.addVersionLabel(String, String, boolean)

removeVersionLabel

void removeVersionLabel(NodeState versionHistoryState,
                        NodeState versionState,
                        Name qLabel)
                        throws VersionException,
                               RepositoryException

Parameters:

versionHistoryState -

versionState -

qLabel -

Throws:

VersionException

RepositoryException

See Also:

VersionHistory.removeVersionLabel(String)

restore

void restore(NodeState nodeState,
             Path relativePath,
             NodeState versionState,
             boolean removeExisting)
             throws VersionException,
                    ItemExistsException,
                    UnsupportedRepositoryOperationException,
                    LockException,
                    InvalidItemStateException,
                    RepositoryException

Parameters:

nodeState -

relativePath -

versionState -

removeExisting -

Throws:

VersionException

ItemExistsException

UnsupportedRepositoryOperationException

LockException

InvalidItemStateException

RepositoryException

See Also:

Node.restore(String, boolean), Node.restore(Version, boolean), Node.restore(Version, String, boolean), Node.restoreByLabel(String, boolean)

restore

void restore(NodeState[] versionStates,
             boolean removeExisting)
             throws ItemExistsException,
                    UnsupportedRepositoryOperationException,
                    VersionException,
                    LockException,
                    InvalidItemStateException,
                    RepositoryException

Parameters:

versionStates -

removeExisting -

Throws:

ItemExistsException

UnsupportedRepositoryOperationException

VersionException

LockException

InvalidItemStateException

RepositoryException

See Also:

Workspace.restore(Version[], boolean)

merge

Iterator<NodeId> merge(NodeState nodeState,
                       String workspaceName,
                       boolean bestEffort)
                       throws NoSuchWorkspaceException,
                              AccessDeniedException,
                              MergeException,
                              LockException,
                              InvalidItemStateException,
                              RepositoryException

Parameters:

nodeState -

workspaceName -

bestEffort -

Returns:

An Iterator over NodeIds of all Nodes that failed to be merged and need manual resolution by the user of the API.

Throws:

NoSuchWorkspaceException

AccessDeniedException

MergeException

LockException

InvalidItemStateException

RepositoryException

See Also:

resolveMergeConflict(NodeState,NodeState,boolean), Node.merge(String, boolean)

merge

Iterator<NodeId> merge(NodeState nodeState,
                       String workspaceName,
                       boolean bestEffort,
                       boolean isShallow)
                       throws NoSuchWorkspaceException,
                              AccessDeniedException,
                              MergeException,
                              LockException,
                              InvalidItemStateException,
                              RepositoryException

Parameters:

nodeState -

workspaceName -

bestEffort -

isShallow -

Returns:

An Iterator over NodeIds of all Nodes that failed to be merged and need manual resolution by the user of the API.

Throws:

NoSuchWorkspaceException

AccessDeniedException

MergeException

LockException

InvalidItemStateException

RepositoryException

See Also:

resolveMergeConflict(NodeState,NodeState,boolean), Node.merge(String, boolean)

resolveMergeConflict

void resolveMergeConflict(NodeState nodeState,
                          NodeState versionState,
                          boolean done)
                          throws VersionException,
                                 InvalidItemStateException,
                                 UnsupportedRepositoryOperationException,
                                 RepositoryException

Parameters:

nodeState -

versionState -

done -

Throws:

VersionException

InvalidItemStateException

UnsupportedRepositoryOperationException

RepositoryException

See Also:

Node.cancelMerge(Version), Node.doneMerge(Version)

createConfiguration

NodeEntry createConfiguration(NodeState nodeState)
                              throws UnsupportedRepositoryOperationException,
                                     RepositoryException

Parameters:

nodeState -

Returns:

Throws:

UnsupportedRepositoryOperationException

RepositoryException

createActivity

NodeEntry createActivity(String title)
                         throws UnsupportedRepositoryOperationException,
                                RepositoryException

Parameters:

title -

Returns:

Throws:

UnsupportedRepositoryOperationException

RepositoryException

removeActivity

void removeActivity(NodeState activityState)
                    throws UnsupportedRepositoryOperationException,
                           RepositoryException

Parameters:

activityState -

Throws:

UnsupportedRepositoryOperationException

RepositoryException

mergeActivity

Iterator<NodeId> mergeActivity(NodeState activityState)
                               throws UnsupportedRepositoryOperationException,
                                      RepositoryException

Parameters:

activityState -

Returns:

Throws:

UnsupportedRepositoryOperationException

RepositoryException

getVersionableNodeEntry

NodeEntry getVersionableNodeEntry(NodeState versionState)
                                  throws RepositoryException

Parameters:

versionState -

Returns:

Throws:

RepositoryException

getVersionHistoryEntry

NodeEntry getVersionHistoryEntry(NodeState versionableState)
                                 throws RepositoryException

Parameters:

versionableState -

Returns:

Throws:

RepositoryException