org.apache.jackrabbit.jcr2spi.version
Interface VersionManager

All Known Implementing Classes:
DefaultVersionManager, 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)
           
 NodeEntry getVersionableNodeEntry(NodeState versionState)
           
 NodeEntry getVersionHistoryEntry(NodeState versionableState)
           
 boolean isCheckedOut(NodeState nodeState)
           
 Iterator merge(NodeState nodeState, String workspaceName, boolean bestEffort)
           
 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 javax.jcr.version.VersionException,
                         javax.jcr.UnsupportedRepositoryOperationException,
                         javax.jcr.InvalidItemStateException,
                         javax.jcr.lock.LockException,
                         javax.jcr.RepositoryException
Parameters:
nodeState -
Returns:
NodeEntry of newly created version
Throws:
javax.jcr.version.VersionException
javax.jcr.UnsupportedRepositoryOperationException
javax.jcr.InvalidItemStateException
javax.jcr.lock.LockException
javax.jcr.RepositoryException
See Also:
Node.checkin()

checkout

void checkout(NodeState nodeState)
              throws javax.jcr.UnsupportedRepositoryOperationException,
                     javax.jcr.lock.LockException,
                     javax.jcr.RepositoryException
Parameters:
nodeState -
Throws:
javax.jcr.UnsupportedRepositoryOperationException
javax.jcr.lock.LockException
javax.jcr.RepositoryException
See Also:
Node.checkout()

isCheckedOut

boolean isCheckedOut(NodeState nodeState)
                     throws javax.jcr.RepositoryException
Parameters:
nodeState -
Returns:
Throws:
javax.jcr.RepositoryException
See Also:
Node.isCheckedOut()

checkIsCheckedOut

void checkIsCheckedOut(NodeState nodeState)
                       throws javax.jcr.version.VersionException,
                              javax.jcr.RepositoryException
Parameters:
nodeState -
Throws:
javax.jcr.version.VersionException - If the Node represented by the given NodeState is checkedin.
javax.jcr.RepositoryException - If another error occurs.
See Also:
Node.isCheckedOut()

removeVersion

void removeVersion(NodeState versionHistoryState,
                   NodeState versionState)
                   throws javax.jcr.ReferentialIntegrityException,
                          javax.jcr.AccessDeniedException,
                          javax.jcr.UnsupportedRepositoryOperationException,
                          javax.jcr.version.VersionException,
                          javax.jcr.RepositoryException
Parameters:
versionHistoryState -
versionState -
Throws:
javax.jcr.ReferentialIntegrityException
javax.jcr.AccessDeniedException
javax.jcr.UnsupportedRepositoryOperationException
javax.jcr.version.VersionException
javax.jcr.RepositoryException
See Also:
VersionHistory.removeVersion(String)

addVersionLabel

void addVersionLabel(NodeState versionHistoryState,
                     NodeState versionState,
                     Name qLabel,
                     boolean moveLabel)
                     throws javax.jcr.version.VersionException,
                            javax.jcr.RepositoryException
Parameters:
versionHistoryState -
versionState -
qLabel -
moveLabel -
Throws:
javax.jcr.version.VersionException
javax.jcr.RepositoryException
See Also:
VersionHistory.addVersionLabel(String, String, boolean)

removeVersionLabel

void removeVersionLabel(NodeState versionHistoryState,
                        NodeState versionState,
                        Name qLabel)
                        throws javax.jcr.version.VersionException,
                               javax.jcr.RepositoryException
Parameters:
versionHistoryState -
versionState -
qLabel -
Throws:
javax.jcr.version.VersionException
javax.jcr.RepositoryException
See Also:
VersionHistory.removeVersionLabel(String)

restore

void restore(NodeState nodeState,
             Path relativePath,
             NodeState versionState,
             boolean removeExisting)
             throws javax.jcr.version.VersionException,
                    javax.jcr.ItemExistsException,
                    javax.jcr.UnsupportedRepositoryOperationException,
                    javax.jcr.lock.LockException,
                    javax.jcr.InvalidItemStateException,
                    javax.jcr.RepositoryException
Parameters:
nodeState -
relativePath -
versionState -
removeExisting -
Throws:
javax.jcr.version.VersionException
javax.jcr.ItemExistsException
javax.jcr.UnsupportedRepositoryOperationException
javax.jcr.lock.LockException
javax.jcr.InvalidItemStateException
javax.jcr.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 javax.jcr.ItemExistsException,
                    javax.jcr.UnsupportedRepositoryOperationException,
                    javax.jcr.version.VersionException,
                    javax.jcr.lock.LockException,
                    javax.jcr.InvalidItemStateException,
                    javax.jcr.RepositoryException
Parameters:
versionStates -
removeExisting -
Throws:
javax.jcr.ItemExistsException
javax.jcr.UnsupportedRepositoryOperationException
javax.jcr.version.VersionException
javax.jcr.lock.LockException
javax.jcr.InvalidItemStateException
javax.jcr.RepositoryException
See Also:
Workspace.restore(Version[], boolean)

merge

Iterator merge(NodeState nodeState,
               String workspaceName,
               boolean bestEffort)
               throws javax.jcr.NoSuchWorkspaceException,
                      javax.jcr.AccessDeniedException,
                      javax.jcr.MergeException,
                      javax.jcr.lock.LockException,
                      javax.jcr.InvalidItemStateException,
                      javax.jcr.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:
javax.jcr.NoSuchWorkspaceException
javax.jcr.AccessDeniedException
javax.jcr.MergeException
javax.jcr.lock.LockException
javax.jcr.InvalidItemStateException
javax.jcr.RepositoryException
See Also:
resolveMergeConflict(NodeState,NodeState,boolean), Node.merge(String, boolean)

resolveMergeConflict

void resolveMergeConflict(NodeState nodeState,
                          NodeState versionState,
                          boolean done)
                          throws javax.jcr.version.VersionException,
                                 javax.jcr.InvalidItemStateException,
                                 javax.jcr.UnsupportedRepositoryOperationException,
                                 javax.jcr.RepositoryException
Parameters:
nodeState -
versionState -
done -
Throws:
javax.jcr.version.VersionException
javax.jcr.InvalidItemStateException
javax.jcr.UnsupportedRepositoryOperationException
javax.jcr.RepositoryException
See Also:
Node.cancelMerge(Version), Node.doneMerge(Version)

getVersionableNodeEntry

NodeEntry getVersionableNodeEntry(NodeState versionState)
                                  throws javax.jcr.RepositoryException
Parameters:
versionState -
Returns:
Throws:
javax.jcr.RepositoryException

getVersionHistoryEntry

NodeEntry getVersionHistoryEntry(NodeState versionableState)
                                 throws javax.jcr.RepositoryException
Parameters:
versionableState -
Returns:
Throws:
javax.jcr.RepositoryException


Copyright © 2004-2011 Apache Software Foundation. All Rights Reserved.