public interface NodeArchiveService
Node stores may be mapped to an associated archive node store. For example, Alfresco ships with the mapping
workspace://SpacesStore
.. maps to .. archive://SpacesStore
.
When a node is deleted
from a regular workspace, it is moved to an archive store if there is a mapping.
This service operates only on nodes that have been archived by either
Modifier and Type | Field and Description |
---|---|
static org.alfresco.service.namespace.QName |
QNAME_ARCHIVED_ITEM
Static 'sys:archivedItem' path for all archived nodes.
|
Modifier and Type | Method and Description |
---|---|
org.alfresco.service.cmr.repository.NodeRef |
getArchivedNode(org.alfresco.service.cmr.repository.NodeRef originalNodeRef)
Get the likely node reference for the original node.
|
org.alfresco.service.cmr.repository.NodeRef |
getStoreArchiveNode(org.alfresco.service.cmr.repository.StoreRef originalStoreRef)
Get the parent node that holds all nodes archived from the given store.
|
boolean |
hasFullAccess(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Check if the current user has authority to access the archived node.
|
org.alfresco.query.PagingResults<org.alfresco.service.cmr.repository.NodeRef> |
listArchivedNodes(ArchivedNodesCannedQueryBuilder cannedQueryBuilder)
Get the archived nodes deleted by the current user.
|
void |
purgeAllArchivedNodes(org.alfresco.service.cmr.repository.StoreRef originalStoreRef)
Permanently delete all archived nodes.
|
void |
purgeArchivedNode(org.alfresco.service.cmr.repository.NodeRef archivedNodeRef)
Permanently delete the archived node.
|
void |
purgeArchivedNodes(List<org.alfresco.service.cmr.repository.NodeRef> archivedNodes)
Permanently delete the archived nodes.
|
RestoreNodeReport |
restoreArchivedNode(org.alfresco.service.cmr.repository.NodeRef archivedNodeRef)
Attempt to restore the given archived node into its original location.
|
RestoreNodeReport |
restoreArchivedNode(org.alfresco.service.cmr.repository.NodeRef archivedNodeRef,
org.alfresco.service.cmr.repository.NodeRef destinationNodeRef,
org.alfresco.service.namespace.QName assocTypeQName,
org.alfresco.service.namespace.QName assocQName)
Attempt to restore the given archived node into a new location.
|
List<RestoreNodeReport> |
restoreArchivedNodes(List<org.alfresco.service.cmr.repository.NodeRef> archivedNodeRefs)
Attempt to restore a list of archived nodes into their original locations,
using the original association types and names.
|
List<RestoreNodeReport> |
restoreArchivedNodes(List<org.alfresco.service.cmr.repository.NodeRef> archivedNodeRefs,
org.alfresco.service.cmr.repository.NodeRef destinationNodeRef,
org.alfresco.service.namespace.QName assocTypeQName,
org.alfresco.service.namespace.QName assocQName)
Attempt to restore a list of archived nodes into a new location.
|
static final org.alfresco.service.namespace.QName QNAME_ARCHIVED_ITEM
org.alfresco.service.cmr.repository.NodeRef getStoreArchiveNode(org.alfresco.service.cmr.repository.StoreRef originalStoreRef)
originalStoreRef
- the original store of the archived nodes. This is the
store where the currently archived nodes could originally be found.org.alfresco.service.cmr.repository.NodeRef getArchivedNode(org.alfresco.service.cmr.repository.NodeRef originalNodeRef)
originalNodeRef
- the original node referenceRestoreNodeReport restoreArchivedNode(org.alfresco.service.cmr.repository.NodeRef archivedNodeRef)
TRANSACTIONS: This method will execute in a new transaction.
archivedNodeRef
- the node's reference in the archiveRestoreNodeReport restoreArchivedNode(org.alfresco.service.cmr.repository.NodeRef archivedNodeRef, org.alfresco.service.cmr.repository.NodeRef destinationNodeRef, org.alfresco.service.namespace.QName assocTypeQName, org.alfresco.service.namespace.QName assocQName)
TRANSACTIONS: This method will execute in a new transaction.
archivedNodeRef
- the node's reference in the archive. This
must be valid.destinationNodeRef
- the parent of the restored node, or
null to use the original parent node referenceassocTypeQName
- the type of the primary association to link the
restored node to the destination parent, or null to use
the orginal association typeassocQName
- the name of the primary association to be created,
or null to use the original association nameList<RestoreNodeReport> restoreArchivedNodes(List<org.alfresco.service.cmr.repository.NodeRef> archivedNodeRefs)
TRANSACTIONS: This method will execute in a new transaction.
archivedNodeRefs
- the nodes' references in the archive. These
must be valid.List<RestoreNodeReport> restoreArchivedNodes(List<org.alfresco.service.cmr.repository.NodeRef> archivedNodeRefs, org.alfresco.service.cmr.repository.NodeRef destinationNodeRef, org.alfresco.service.namespace.QName assocTypeQName, org.alfresco.service.namespace.QName assocQName)
TRANSACTIONS: This method will execute in a new transaction.
archivedNodeRefs
- the nodes' references in the archive. These
must be valid.destinationNodeRef
- the parent of the restored nodes, or
null to use the original parent node referencesassocTypeQName
- the type of the primary associations to link the
restored node to the destination parent, or null to use
the orginal association typesassocQName
- the name of the primary associations to be created,
or null to use the original association namesvoid purgeArchivedNode(org.alfresco.service.cmr.repository.NodeRef archivedNodeRef)
archivedNodeRef
- the archived node to delete.NodeService.deleteNode(NodeRef)
void purgeArchivedNodes(List<org.alfresco.service.cmr.repository.NodeRef> archivedNodes)
archivedNodes
- the archived nodes to delete.void purgeAllArchivedNodes(org.alfresco.service.cmr.repository.StoreRef originalStoreRef)
originalStoreRef
- the store that the items originally came fromorg.alfresco.query.PagingResults<org.alfresco.service.cmr.repository.NodeRef> listArchivedNodes(ArchivedNodesCannedQueryBuilder cannedQueryBuilder)
cannedQueryBuilder
- the object that holds the required and optional
parameters to perform the canned queryboolean hasFullAccess(org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- NodeRefCopyright © 2005–2017 Alfresco Software. All rights reserved.