From 4e6e53e0b4afabced4d655c0edb217151d74ad1e Mon Sep 17 00:00:00 2001
From: dhulley <Derek.Hulley@alfresco.com>
Date: Fri, 4 Nov 2016 11:40:23 +0000
Subject: [PATCH] MNT-16527: Improve API documentation description for
 deleteNode, purgeArchivedNode and NodeService

---
 .../alfresco/service/cmr/repository/NodeService.java | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/src/main/java/org/alfresco/service/cmr/repository/NodeService.java b/src/main/java/org/alfresco/service/cmr/repository/NodeService.java
index d4ed87fce8..449b4dad9c 100644
--- a/src/main/java/org/alfresco/service/cmr/repository/NodeService.java
+++ b/src/main/java/org/alfresco/service/cmr/repository/NodeService.java
@@ -316,6 +316,16 @@ public interface NodeService
      * All associations (both children and regular node associations)
      * will be deleted, and where the given node is the primary parent,
      * the children will also be cascade deleted.
+     * <p>
+     * Node stores <i>may</i> be mapped to an associated archive node store.  For example, Alfresco ships with the mapping<br>
+     * {@link StoreRef#STORE_REF_WORKSPACE_SPACESSTORE workspace://SpacesStore} .. maps to .. {@link StoreRef#STORE_REF_ARCHIVE_SPACESSTORE archive://SpacesStore}.<br>
+     * When a node is deleted:
+     * <ul>
+     *   <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>
+     *   <li>If there *is no mapping* from the node's current store, then the node is permanently deleted</li>
+     * </ul>
+     * When nodes have been archived, they contain all the details of the original location.  Use the {@link #restoreNode(NodeRef, NodeRef, QName, QName) restore}
+     * feature to return a node back to its original store.
      * 
      * @param nodeRef reference to a node within a store
      * @throws InvalidNodeRefException if the reference given is invalid
@@ -852,7 +862,7 @@ public interface NodeService
     /**
      * Restore an individual node (along with its sub-tree nodes) to the target location.
      * The archived node must have the {@link org.alfresco.model.ContentModel#ASPECT_ARCHIVED archived aspect}
-     * set against it.
+     * set against it.  This would have been applied when a node was originally {@link #deleteNode(NodeRef) deleted}.
      * 
      * @param archivedNodeRef the archived node
      * @param destinationParentNodeRef the parent to move the node into