|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface VersionService
Interface for public and internal version operations.
Field Summary | |
---|---|
static java.lang.String |
VERSION_STORE_PROTOCOL
The version store protocol label, used in store references |
Method Summary | |
---|---|
java.util.Collection |
createVersion(java.util.Collection nodeRefs,
java.util.Map versionProperties)
Creates new versions based on the list of node references provided. |
Version |
createVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef,
java.util.Map versionProperties)
Creates a new version based on the referenced node. |
java.util.Collection |
createVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef,
java.util.Map versionProperties,
boolean versionChildren)
Creates a new version based on the referenced node. |
void |
deleteVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef,
Version version)
Delete a specific version associated with a node reference. |
void |
deleteVersionHistory(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Delete the version history associated with a node reference. |
void |
ensureVersioningEnabled(org.alfresco.service.cmr.repository.NodeRef nodeRef,
java.util.Map versionProperties)
Ensures that a node has the versionable aspect applied to it, and has at least an initial entry in the version store. |
Version |
getCurrentVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Gets the version object for the current version of the node reference passed. |
VersionHistory |
getVersionHistory(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Gets the version history information for a node. |
org.alfresco.service.cmr.repository.StoreRef |
getVersionStoreReference()
Gets the reference to the version store |
void |
registerVersionLabelPolicy(org.alfresco.service.namespace.QName typeQName,
VersionServicePolicies.CalculateVersionLabelPolicy policy)
Register a version label policy |
org.alfresco.service.cmr.repository.NodeRef |
restore(org.alfresco.service.cmr.repository.NodeRef nodeRef,
org.alfresco.service.cmr.repository.NodeRef parentNodeRef,
org.alfresco.service.namespace.QName assocTypeQName,
org.alfresco.service.namespace.QName assocQName)
By default a deep restore is performed. |
org.alfresco.service.cmr.repository.NodeRef |
restore(org.alfresco.service.cmr.repository.NodeRef nodeRef,
org.alfresco.service.cmr.repository.NodeRef parentNodeRef,
org.alfresco.service.namespace.QName assocTypeQName,
org.alfresco.service.namespace.QName assocQName,
boolean deep)
Restores a node not currently present in the store, but that has a version history. |
void |
revert(org.alfresco.service.cmr.repository.NodeRef nodeRef)
The node reference will be reverted to the current version. |
void |
revert(org.alfresco.service.cmr.repository.NodeRef nodeRef,
boolean deep)
The node reference will be reverted to the current version. |
void |
revert(org.alfresco.service.cmr.repository.NodeRef nodeRef,
Version version)
A deep revert will take place by default. |
void |
revert(org.alfresco.service.cmr.repository.NodeRef nodeRef,
Version version,
boolean deep)
Revert the state of the node to the specified version. |
Field Detail |
---|
static final java.lang.String VERSION_STORE_PROTOCOL
Method Detail |
---|
@Auditable org.alfresco.service.cmr.repository.StoreRef getVersionStoreReference()
@Auditable(parameters={"nodeRef", "versionProperties"}) Version createVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.util.Map versionProperties) throws ReservedVersionNameException, AspectMissingException
If the node has not previously been versioned then a version history and initial version will be created.
If the node referenced does not or can not have the version aspect applied to it then an exception will be raised.
The version properties are stored as version meta-data against the newly created version.
nodeRef
- a node referenceversionProperties
- the version properties that are stored with the newly created
version, or null if there are no relevant properties
ReservedVersionNameException
- thrown if a reserved property name is used int he version properties
provided
AspectMissingException
- thrown if the version aspect is missing@Auditable(parameters={"nodeRef", "versionProperties", "versionChildren"}) java.util.Collection createVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.util.Map versionProperties, boolean versionChildren) throws ReservedVersionNameException, AspectMissingException
If the node has not previously been versioned then a version history and initial version will be created.
If the node referenced does not or can not have the version aspect applied to it then an exception will be raised.
The version properties are stored as version meta-data against the newly created version.
nodeRef
- a node referenceversionProperties
- the version properties that are stored with the newly created
versionversionChildren
- if true then the children of the referenced node are also
versioned, false otherwise
ReservedVersionNameException
- thrown if a reserved property name is used int he version properties
provided
AspectMissingException
- thrown if the version aspect is missing@Auditable(parameters={"nodeRef", "versionProperties"}) java.util.Collection createVersion(java.util.Collection nodeRefs, java.util.Map versionProperties) throws ReservedVersionNameException, AspectMissingException
nodeRefs
- a list of node referencesversionProperties
- version property values
ReservedVersionNameException
- thrown if a reserved property name is used in the version properties
provided
AspectMissingException
- thrown if the version aspect is missing@Auditable(parameters="nodeRef") VersionHistory getVersionHistory(org.alfresco.service.cmr.repository.NodeRef nodeRef) throws AspectMissingException
If the node has not been versioned then null is returned.
If the node referenced does not or can not have the version aspect applied to it then an exception will be raised.
nodeRef
- a node reference
AspectMissingException
- thrown if the version aspect is missing@Auditable(parameters="nodeRef") Version getCurrentVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Returns null if the node is not versionable or has not been versioned.
nodeRef
- the node reference
@Auditable(parameters="nodeRef") void revert(org.alfresco.service.cmr.repository.NodeRef nodeRef)
A deep revert will be performed.
nodeRef
- the node referenceVersionService.revert(NodeRef, Version, boolean)
@Auditable(parameters={"nodeRef", "deep"}) void revert(org.alfresco.service.cmr.repository.NodeRef nodeRef, boolean deep)
nodeRef
- the node referencedeep
- true if a deep revert is to be performed, flase otherwiseVersionService.revert(NodeRef, Version, boolean)
@Auditable(parameters={"nodeRef", "version"}) void revert(org.alfresco.service.cmr.repository.NodeRef nodeRef, Version version)
nodeRef
- the node referenceversion
- the version to revert toVersionService.revert(NodeRef, Version, boolean)
@Auditable(parameters={"nodeRef", "version", "deep"}) void revert(org.alfresco.service.cmr.repository.NodeRef nodeRef, Version version, boolean deep)
Any changes made to the node will be lost and the state of the node will reflect that of the version specified.
The version label property on the node reference will remain unchanged.
If the node is further versioned then the new version will be created at the head of the version history graph. A branch will not be created.
If a deep revert is to be performed then any child nodes that are no longer present will be deep restored (if appropriate) otherwise child associations to deleted, versioned nodes will not be restored.
nodeRef
- the node referenceversion
- the version to revert todeep
- true is a deep revert is to be performed, false otherwise.@Auditable(parameters={"nodeRef", "parentNodeRef", "assocTypeQName", "assocQName"}) org.alfresco.service.cmr.repository.NodeRef restore(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.cmr.repository.NodeRef parentNodeRef, org.alfresco.service.namespace.QName assocTypeQName, org.alfresco.service.namespace.QName assocQName)
nodeRef
- the node reference to a node that no longer exists in the storeparentNodeRef
- the new parent of the restored nodeassocTypeQName
- the assoc type qnameassocQName
- the assoc qname
VersionService.restore(NodeRef, NodeRef, QName, QName, boolean)
@Auditable(parameters={"nodeRef", "parentNodeRef", "assocTypeQName", "assocQName", "deep"}) org.alfresco.service.cmr.repository.NodeRef restore(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.cmr.repository.NodeRef parentNodeRef, org.alfresco.service.namespace.QName assocTypeQName, org.alfresco.service.namespace.QName assocQName, boolean deep)
The restored node will be at the head (most resent version).
Restoration will fail if there is no version history for the specified node id in the specified store.
If the node already exists in the store then an exception will be raised.
Once the node is restored it is reverted to the head version in the appropriate version history tree. If deep is set to true then this will be a deep revert, false otherwise.
nodeRef
- the node reference to a node that no longer exists in
the storeparentNodeRef
- the new parent of the restored nodeassocTypeQName
- the assoc type qnameassocQName
- the assoc qnamedeep
- true is a deep revert should be performed once the node has been
restored, false otherwise
@Auditable(parameters="nodeRef") void deleteVersionHistory(org.alfresco.service.cmr.repository.NodeRef nodeRef) throws AspectMissingException
This operation is permanent, all versions in the version history are deleted and cannot be retrieved.
The current version label for the node reference is reset and any subsequent versions of the node will result in a new version history being created.
nodeRef
- the node reference
AspectMissingException
- thrown if the version aspect is missing@Auditable(parameters={"nodeRef", "version"}) void deleteVersion(org.alfresco.service.cmr.repository.NodeRef nodeRef, Version version)
This operation is permanent, the specific version in the version history is deleted and cannot be retrieved.
If this is the last version, then the current version label for the node reference is reset and any subsequent versions of the node will result in a new version history being created.
nodeRef
- the node referenceversion
- the version to delete@Auditable(parameters="nodeRef") void ensureVersioningEnabled(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.util.Map versionProperties)
nodeRef
- the node referenceversionProperties
- the version properties to apply if versioning
isn't currently enabled for the nodevoid registerVersionLabelPolicy(org.alfresco.service.namespace.QName typeQName, VersionServicePolicies.CalculateVersionLabelPolicy policy)
typeQName
- the QName of the type to registerpolicy
- the policy to register for the specified type
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |