org.exoplatform.services.jcr.rmi.api.remote
Interface RemoteVersionHistory

All Superinterfaces:

java.rmi.Remote, RemoteItem, RemoteNode

All Known Implementing Classes:

ServerVersionHistory

public interface RemoteVersionHistory
extends RemoteNode

Remote version of the JC VersionHistory interface. Used by the ServerVersionHistory and ClientVersionHistory adapters to provide transparent RMI access to remote version histories.

The methods in this interface are documented only with a reference to a corresponding VersionHistory method. The remote object will simply forward the method call to the underlying VersionHistory instance. Argument and return values, as well as possible exceptions, are copied over the network. Complex return values (like Versions) are returned as remote references to the corresponding remote interfaces. Iterator values are transmitted as object arrays. RMI errors are signalled with RemoteExceptions.

See Also:

Version, ClientVersionHistory, ServerVersionHistory

Method Summary

void	addVersionLabel(java.lang.String versionName, java.lang.String label, boolean moveLabel) Remote version of the VersionHistory.addVersionLabel(String, String, boolean) method.
RemoteIterator	getAllVersions() Remote version of the VersionHistory.getAllVersions() method.
RemoteVersion	getRootVersion() Remote version of the VersionHistory.getRootVersion() method.
RemoteVersion	getVersion(java.lang.String versionName) Remote version of the VersionHistory.getVersion(String) method.
java.lang.String	getVersionableUUID() Remote version of the VersionHistory.getVersionableUUID() VersionHistory.getVersionableUUID()} method.
RemoteVersion	getVersionByLabel(java.lang.String label) Remote version of the VersionHistory.getVersionByLabel(String) method.
java.lang.String[]	getVersionLabels() Remote version of the VersionHistory.getVersionLabels() method.
java.lang.String[]	getVersionLabels(java.lang.String versionUUID) Remote version of the VersionHistory.getVersionLabels(Version) method.
boolean	hasVersionLabel(java.lang.String label) Remote version of the VersionHistory.hasVersionLabel(String) method.
boolean	hasVersionLabel(java.lang.String versionUUID, java.lang.String label) Remote version of the hasVersionLabel(Version, String) method.
void	removeVersion(java.lang.String versionName) Remote version of the VersionHistory.removeVersion(String) method.
void	removeVersionLabel(java.lang.String label) Remote version of the VersionHistory.removeVersionLabel(String) method.

Methods inherited from interface org.exoplatform.services.jcr.rmi.api.remote.RemoteNode

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, restoreByLabel, restoreByUUID, setProperty, setProperty, setProperty, setProperty, unlock, update

Methods inherited from interface org.exoplatform.services.jcr.rmi.api.remote.RemoteItem

getAncestor, getDepth, getName, getParent, getPath, isModified, isNew, refresh, remove, save

Method Detail

getRootVersion

RemoteVersion getRootVersion()
                             throws javax.jcr.RepositoryException,
                                    java.rmi.RemoteException

Remote version of the VersionHistory.getRootVersion() method.

Returns:

a Version object.

Throws:

javax.jcr.RepositoryException - if an error occurs.

java.rmi.RemoteException - on RMI errors

getAllVersions

RemoteIterator getAllVersions()
                              throws javax.jcr.RepositoryException,
                                     java.rmi.RemoteException

Remote version of the VersionHistory.getAllVersions() method.

Returns:

remote versions

Throws:

javax.jcr.RepositoryException - if an error occurs.

java.rmi.RemoteException - on RMI errors

getVersion

RemoteVersion getVersion(java.lang.String versionName)
                         throws javax.jcr.RepositoryException,
                                java.rmi.RemoteException

Remote version of the VersionHistory.getVersion(String) method.

Parameters:

versionName - a version name

Returns:

a Version object.

Throws:

javax.jcr.RepositoryException - if an error occurs.

java.rmi.RemoteException - on RMI errors

getVersionByLabel

RemoteVersion getVersionByLabel(java.lang.String label)
                                throws javax.jcr.RepositoryException,
                                       java.rmi.RemoteException

Remote version of the VersionHistory.getVersionByLabel(String) method.

Parameters:

label - a version label

Returns:

a Version object.

Throws:

javax.jcr.RepositoryException - if an error occurs.

java.rmi.RemoteException - on RMI errors

addVersionLabel

void addVersionLabel(java.lang.String versionName,
                     java.lang.String label,
                     boolean moveLabel)
                     throws javax.jcr.RepositoryException,
                            java.rmi.RemoteException

Remote version of the VersionHistory.addVersionLabel(String, String, boolean) method.

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:

javax.jcr.RepositoryException - if another error occurs.

java.rmi.RemoteException - on RMI errors

removeVersionLabel

void removeVersionLabel(java.lang.String label)
                        throws javax.jcr.RepositoryException,
                               java.rmi.RemoteException

Remote version of the VersionHistory.removeVersionLabel(String) method.

Parameters:

label - a version label

Throws:

javax.jcr.RepositoryException - if another error occurs.

java.rmi.RemoteException - on RMI errors

hasVersionLabel

boolean hasVersionLabel(java.lang.String label)
                        throws javax.jcr.RepositoryException,
                               java.rmi.RemoteException

Remote version of the VersionHistory.hasVersionLabel(String) method.

Parameters:

label - a version label

Returns:

a boolean

Throws:

javax.jcr.RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

hasVersionLabel

boolean hasVersionLabel(java.lang.String versionUUID,
                        java.lang.String label)
                        throws javax.jcr.RepositoryException,
                               java.rmi.RemoteException

Remote version of the hasVersionLabel(Version, String) method.

Parameters:

versionUUID - The UUID of the version whose labels are to be returned.

label - a version label

Returns:

a boolean.

Throws:

javax.jcr.RepositoryException - if another error occurs.

java.rmi.RemoteException - on RMI errors

getVersionLabels

java.lang.String[] getVersionLabels()
                                    throws javax.jcr.RepositoryException,
                                           java.rmi.RemoteException

Remote version of the VersionHistory.getVersionLabels() method.

Returns:

a String array containing all the labels of the version history

Throws:

javax.jcr.RepositoryException - on repository errors

java.rmi.RemoteException - on RMI errors

getVersionLabels

java.lang.String[] getVersionLabels(java.lang.String versionUUID)
                                    throws javax.jcr.RepositoryException,
                                           java.rmi.RemoteException

Remote version of the VersionHistory.getVersionLabels(Version) method.

Parameters:

versionUUID - The UUID of the version whose labels are to be returned.

Returns:

a String array containing all the labels of the given version

Throws:

javax.jcr.RepositoryException - if another error occurs.

java.rmi.RemoteException - on RMI errors

removeVersion

void removeVersion(java.lang.String versionName)
                   throws javax.jcr.RepositoryException,
                          java.rmi.RemoteException

Remote version of the VersionHistory.removeVersion(String) method.

Parameters:

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

Throws:

javax.jcr.RepositoryException - if another error occurs.

java.rmi.RemoteException - on RMI errors

getVersionableUUID

java.lang.String getVersionableUUID()
                                    throws javax.jcr.RepositoryException,
                                           java.rmi.RemoteException

Remote version of the VersionHistory.getVersionableUUID() VersionHistory.getVersionableUUID()} method.

Returns:

the uuid of the versionable node

Throws:

javax.jcr.RepositoryException - if another error occurs.

java.rmi.RemoteException - on RMI errors