inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-10-08 14:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@132393 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Derek Hulley
2016-11-04 11:45:54 +00:00
parent de2f2f00d7
commit 75d056f198
1 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
source/java/org/alfresco/repo/node/archive/NodeArchiveService.java
View File

@@ -29,6 +29,7 @@ import java.util.List;
import org.alfresco.query.PagingResults; import org.alfresco.query.PagingResults;
import org.alfresco.service.cmr.repository.NodeRef; import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.repository.StoreRef; import org.alfresco.service.cmr.repository.StoreRef;
import org.alfresco.service.namespace.NamespaceService; import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName; import org.alfresco.service.namespace.QName;
@@ -36,6 +37,17 @@ import org.alfresco.service.namespace.QName;
/** /**
* A service interface providing methods that map onto the low-level * A service interface providing methods that map onto the low-level
* node restore functionality. * node restore functionality.
* <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 {@link NodeService#deleteNode(NodeRef) deleted} from a regular workspace, it is moved to an archive store if there is a mapping.
* <p>
* This service operates <b>only on nodes that have been archived</b> by either
* <ul>
* <li>{@link #getArchivedNode(NodeRef) retrieving archived nodes},</li>
* <li>{@link #purgeArchivedNode(NodeRef) permanently deleting archived nodes},</li>
* <li>or {@link #restoreArchivedNode(NodeRef) restoring archived nodes back to their original location}.</li>
* </ul>
* *
* @author Derek Hulley * @author Derek Hulley
*/ */
@@ -133,6 +145,8 @@ public interface NodeArchiveService
* Permanently delete the archived node. * Permanently delete the archived node.
* *
* @param archivedNodeRef the archived node to delete. * @param archivedNodeRef the archived node to delete.
*
* @see NodeService#deleteNode(NodeRef)
*/ */
public void purgeArchivedNode(NodeRef archivedNodeRef); public void purgeArchivedNode(NodeRef archivedNodeRef);