org.apache.jackrabbit.core.version
Interface VersionManager

All Known Implementing Classes:

VersionManagerImpl, XAVersionManager

public interface VersionManager

This interface defines the version manager. It gives access to the underlying persistence layer of the versioning.

Method Summary

javax.jcr.version.Version	checkin(NodeImpl node) invokes the checkin() on the persistent version manager and remaps the newly created version objects.
void	close() Close this version manager.
InternalVersion	getVersion(NodeId id) Returns the version with the given id
InternalVersionHistory	getVersionHistory(NodeId id) Returns the version history with the given id
VersionHistoryInfo	getVersionHistory(javax.jcr.Session session, NodeState node) Returns information about the version history of the specified node.
VirtualItemStateProvider	getVirtualItemStateProvider() returns the virtual item state provider that exposes the internal versions as items.
void	removeVersion(javax.jcr.version.VersionHistory history, Name versionName) Removes the specified version from the given version history.
javax.jcr.version.Version	setVersionLabel(javax.jcr.version.VersionHistory history, Name version, Name label, boolean move) Sets the version label to the given version.

Method Detail

getVirtualItemStateProvider

VirtualItemStateProvider getVirtualItemStateProvider()

returns the virtual item state provider that exposes the internal versions as items.

Returns:

the virtual item state provider.

getVersionHistory

VersionHistoryInfo getVersionHistory(javax.jcr.Session session,
                                     NodeState node)
                                     throws javax.jcr.RepositoryException

Returns information about the version history of the specified node. If the given node does not already have an associated version history, then an empty history is automatically created. This method should only be called by code that already knows that the specified node is versionable.

Parameters:

session -

node - node whose version history should be returned

Returns:

identifiers of the version history and root version nodes

Throws:

javax.jcr.RepositoryException - if an error occurs

checkin

javax.jcr.version.Version checkin(NodeImpl node)
                                  throws javax.jcr.RepositoryException

invokes the checkin() on the persistent version manager and remaps the newly created version objects.

Parameters:

node -

Returns:

Throws:

javax.jcr.RepositoryException

removeVersion

void removeVersion(javax.jcr.version.VersionHistory history,
                   Name versionName)
                   throws javax.jcr.RepositoryException

Removes the specified version from the given version history.

Parameters:

history -

versionName -

Throws:

javax.jcr.RepositoryException

setVersionLabel

javax.jcr.version.Version setVersionLabel(javax.jcr.version.VersionHistory history,
                                          Name version,
                                          Name label,
                                          boolean move)
                                          throws javax.jcr.RepositoryException

Sets the version label to the given version. If the label is already assigned to another version, a VersionException is thrown unless move is true. If version is null, the label is removed from the respective version. In either case, the version the label was previously assigned is returned, or null of the label was not moved.

Parameters:

history -

version -

label -

move -

Returns:

Throws:

javax.jcr.RepositoryException

getVersionHistory

InternalVersionHistory getVersionHistory(NodeId id)
                                         throws javax.jcr.RepositoryException

Returns the version history with the given id

Parameters:

id -

Returns:

the version history.

Throws:

javax.jcr.RepositoryException

getVersion

InternalVersion getVersion(NodeId id)
                           throws javax.jcr.RepositoryException

Returns the version with the given id

Parameters:

id -

Returns:

the version.

Throws:

javax.jcr.RepositoryException

close

void close()
           throws java.lang.Exception

Close this version manager. After having closed a persistence manager, further operations on this object are treated as illegal and throw

Throws:

java.lang.Exception - if an error occurs