Commit 4e6e53e0b4afabced4d655c0edb217151d74ad1e

Authored by Derek Hulley
1 parent 141ca4a2d2
Exists in master

MNT-16527: Improve API documentation description for deleteNode, purgeArchivedNode and NodeService

src/main/java/org/alfresco/service/cmr/repository/NodeService.java
... ... @@ -316,6 +316,16 @@ public interface NodeService
316 316 * All associations (both children and regular node associations)
317 317 * will be deleted, and where the given node is the primary parent,
318 318 * the children will also be cascade deleted.
  319 + * <p>
  320 + * Node stores <i>may</i> be mapped to an associated archive node store. For example, Alfresco ships with the mapping<br>
  321 + * {@link StoreRef#STORE_REF_WORKSPACE_SPACESSTORE workspace://SpacesStore} .. maps to .. {@link StoreRef#STORE_REF_ARCHIVE_SPACESSTORE archive://SpacesStore}.<br>
  322 + * When a node is deleted:
  323 + * <ul>
  324 + * <li>If there *is a mapping* from the node's current store to an archive store, the node is first copied to the archive store</li>
  325 + * <li>If there *is no mapping* from the node's current store, then the node is permanently deleted</li>
  326 + * </ul>
  327 + * When nodes have been archived, they contain all the details of the original location. Use the {@link #restoreNode(NodeRef, NodeRef, QName, QName) restore}
  328 + * feature to return a node back to its original store.
319 329 *
320 330 * @param nodeRef reference to a node within a store
321 331 * @throws InvalidNodeRefException if the reference given is invalid
... ... @@ -852,7 +862,7 @@ public interface NodeService
852 862 /**
853 863 * Restore an individual node (along with its sub-tree nodes) to the target location.
854 864 * The archived node must have the {@link org.alfresco.model.ContentModel#ASPECT_ARCHIVED archived aspect}
855   - * set against it.
  865 + * set against it. This would have been applied when a node was originally {@link #deleteNode(NodeRef) deleted}.
856 866 *
857 867 * @param archivedNodeRef the archived node
858 868 * @param destinationParentNodeRef the parent to move the node into
... ...