inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-07-24 17:32:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge from head.

Browse Source 
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/WCM-DEV2/root@3314 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Britt Park
2006-07-13 07:06:30 +00:00
parent b601821d98
commit fae76d7896
41 changed files with 1354 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
source/java/org/alfresco/service/cmr/coci/CheckOutCheckInService.java
View File

@@ -19,6 +19,7 @@ package org.alfresco.service.cmr.coci;
import java.io.Serializable;
import java.util.Map;
import org.alfresco.service.Auditable;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.namespace.QName;
@@ -33,10 +34,10 @@ public interface CheckOutCheckInService
/**
* Checks out the given node placing a working copy in the destination specified.
* <p>
* When a node is checked out a read-only lock is placed on the origional node and
* When a node is checked out a read-only lock is placed on the original node and
* a working copy is placed in the destination specified.
* <p>
* The copy aspect is applied to the working copy so that the origional node can be
* The copy aspect is applied to the working copy so that the original node can be
* identified.
* <p>
* The working copy aspect is applied to the working copy so that it can be identified
@@ -53,6 +54,7 @@ public interface CheckOutCheckInService
* the working copy
* @return node reference to the created working copy
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef", "destinationParentNodeRef", "destinationAssocTypeQName", "destinationAssocQName"})
public NodeRef checkout(
NodeRef nodeRef,
NodeRef destinationParentNodeRef,
@@ -68,38 +70,40 @@ public interface CheckOutCheckInService
* @param nodeRef a reference to the node to checkout
* @return a node reference to the created working copy
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
public NodeRef checkout(NodeRef nodeRef);
/**
* Checks in the working node specified.
* <p>
* When a working copy is checked in the current state of the working copy is copyied to the
* origional node. This will include any content updated in the working node.
* When a working copy is checked in the current state of the working copy is copied to the
* original node. This will include any content updated in the working node.
* <p>
* If version properties are provided the origional node will be versioned and updated accordingly.
* If version properties are provided the original node will be versioned and updated accordingly.
* <p>
* If a content Url is provided it will be used to update the content of the working node before the
* checkin opertaion takes place.
* checkin operation takes place.
* <p>
* Once the operation has completed the read lock applied to the origional node during checkout will
* Once the operation has completed the read lock applied to the original node during checkout will
* be removed and the working copy of the node deleted from the repository, unless the operation is
* instructed to keep the origional node checked out. In which case the lock and the working copy will
* instructed to keep the original node checked out. In which case the lock and the working copy will
* remain.
* <p>
* The node reference to the origional node is returned.
* The node reference to the original node is returned.
*
* @param workingCopyNodeRef the working copy node reference
* @param versionProperties the version properties. If null is passed then the origional node
* @param versionProperties the version properties. If null is passed then the original node
* is NOT versioned during the checkin operation.
* @param contentUrl a content url that should be set on the working copy before
* the checkin opertation takes place. If null then the current working
* copy content is copied back to the origional node.
* the checkin operation takes place. If null then the current working
* copy content is copied back to the original node.
* @param keepCheckedOut indicates whether the node should remain checked out after the checkin
* has taken place. When the node remains checked out the working node
* reference remains the same.
* @return the node reference to the origional node, updated with the checked in
* @return the node reference to the original node, updated with the checked in
* state
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"workingCopyNodeRef", "versionProperties", "contentUrl", "keepCheckedOut"})
public NodeRef checkin(
NodeRef workingCopyNodeRef,
Map<String,Serializable> versionProperties,
@@ -112,14 +116,15 @@ public interface CheckOutCheckInService
* @see VersionOperationsService#checkin(NodeRef, HashMap<String,Serializable>, String, boolean)
*
* @param workingCopyNodeRef the working copy node reference
* @param versionProperties the version properties. If null is passed then the origional node
* @param versionProperties the version properties. If null is passed then the original node
* is NOT versioned during the checkin operation.
* @param contentUrl a content url that should be set on the working copy before
* the checkin opertation takes place. If null then the current working
* copy content is copied back to the origional node.
* @return the node reference to the origional node, updated with the checked in
* the checkin operation takes place. If null then the current working
* copy content is copied back to the original node.
* @return the node reference to the original node, updated with the checked in
* state
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"workingCopyNodeRef", "versionProperties", "contentUrl"})
public NodeRef checkin(
NodeRef workingCopyNodeRef,
Map<String, Serializable> versionProperties,
@@ -132,11 +137,12 @@ public interface CheckOutCheckInService
* @see VersionOperationsService#checkin(NodeRef, HashMap<String,Serializable>, String)
*
* @param workingCopyNodeRef the working copy node reference
* @param versionProperties the version properties. If null is passed then the origional node
* @param versionProperties the version properties. If null is passed then the original node
* is NOT versioned during the checkin operation.
* @return the node reference to the origional node, updated with the checked in
* @return the node reference to the original node, updated with the checked in
* state
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"workingCopyNodeRef", "versionProperties"})
public NodeRef checkin(
NodeRef workingCopyNodeRef,
Map<String, Serializable> versionProperties);
@@ -144,16 +150,17 @@ public interface CheckOutCheckInService
/**
* Cancels the checkout for a given working copy.
* <p>
* The read-only lock on the origional node is removed and the working copy is removed.
* The read-only lock on the original node is removed and the working copy is removed.
* <p>
* Note that all modification made to the working copy will be lost and the origional node
* will remiain unchanged.
* Note that all modification made to the working copy will be lost and the original node
* will remain unchanged.
* <p>
* A reference to the origional node reference is returned.
* A reference to the original node reference is returned.
*
* @param workingCopyNodeRef the working copy node reference
* @return the origional node reference
* @return the original node reference
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"workingCopyNodeRef"})
public NodeRef cancelCheckout(NodeRef workingCopyNodeRef);
/**
@@ -164,5 +171,6 @@ public interface CheckOutCheckInService
* @param nodeRef a node reference
* @return the working copy node reference or null if none.
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"nodeRef"})
public NodeRef getWorkingCopy(NodeRef nodeRef);
}