@AlfrescoPublicApi
public interface CheckOutCheckInService
Modifier and Type | Method and Description |
---|---|
org.alfresco.service.cmr.repository.NodeRef |
cancelCheckout(org.alfresco.service.cmr.repository.NodeRef workingCopyNodeRef)
Cancels the checkout for a given working copy.
|
org.alfresco.service.cmr.repository.NodeRef |
checkin(org.alfresco.service.cmr.repository.NodeRef workingCopyNodeRef,
Map<String,Serializable> versionProperties)
If no content url is specified then current content set on the working
copy is understood to be current.
|
org.alfresco.service.cmr.repository.NodeRef |
checkin(org.alfresco.service.cmr.repository.NodeRef workingCopyNodeRef,
Map<String,Serializable> versionProperties,
String contentUrl)
By default the checked in node is not keep checked in.
|
org.alfresco.service.cmr.repository.NodeRef |
checkin(org.alfresco.service.cmr.repository.NodeRef workingCopyNodeRef,
Map<String,Serializable> versionProperties,
String contentUrl,
boolean keepCheckedOut)
Checks in the working node specified.
|
org.alfresco.service.cmr.repository.NodeRef |
checkout(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Checks out the working copy of the node into the same parent node with the same child
associations details.
|
org.alfresco.service.cmr.repository.NodeRef |
checkout(org.alfresco.service.cmr.repository.NodeRef nodeRef,
org.alfresco.service.cmr.repository.NodeRef destinationParentNodeRef,
org.alfresco.service.namespace.QName destinationAssocTypeQName,
org.alfresco.service.namespace.QName destinationAssocQName)
Checks out the given node placing a working copy in the destination specified.
|
org.alfresco.service.cmr.repository.NodeRef |
getCheckedOut(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Helper method to retrieve the original node (check-out source) for a working copy.
|
org.alfresco.service.cmr.repository.NodeRef |
getWorkingCopy(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Helper method to retrieve the working copy node reference for a checked out node.
|
boolean |
isCheckedOut(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Determine if a node has been checked out or not
|
boolean |
isWorkingCopy(org.alfresco.service.cmr.repository.NodeRef nodeRef)
Determine if a node is a working copy or not
|
@Auditable(parameters={"nodeRef","destinationParentNodeRef","destinationAssocTypeQName","destinationAssocQName"}) org.alfresco.service.cmr.repository.NodeRef checkout(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.cmr.repository.NodeRef destinationParentNodeRef, org.alfresco.service.namespace.QName destinationAssocTypeQName, org.alfresco.service.namespace.QName destinationAssocQName)
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.
The copy aspect is applied to the working copy so that the original node can be identified.
The working copy aspect is applied to the working copy so that it can be identified as the working copy of a checked out node.
The working copy node reference is returned to the caller.
nodeRef
- a reference to the node to checkoutdestinationParentNodeRef
- the destination node reference for the working
copydestinationAssocTypeQName
- the destination child assoc type for the working
copydestinationAssocQName
- the destination child assoc qualified name for
the working copy@Auditable(parameters="nodeRef") org.alfresco.service.cmr.repository.NodeRef checkout(org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- a reference to the node to checkoutcheckout(NodeRef, NodeRef, QName, QName)
@Auditable(parameters={"workingCopyNodeRef","versionProperties","contentUrl","keepCheckedOut"}) org.alfresco.service.cmr.repository.NodeRef checkin(org.alfresco.service.cmr.repository.NodeRef workingCopyNodeRef, Map<String,Serializable> versionProperties, String contentUrl, boolean keepCheckedOut)
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.
If versioning is not enabled on a node (the versionable aspect is not present on the node), the check in overwrites the existing node and releases the lock unless the keepCheckedOut flag is used. With versioning enabled on the node, a new version is always created.
If a content Url is provided it will be used to update the content of the working node before the checkin operation takes place.
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 original node checked out. In which case the lock and the working copy will remain.
The node reference to the original node is returned.
workingCopyNodeRef
- the working copy node referenceversionProperties
- the version properties. If null is passed then the original node
is NOT versioned during the checkin operation.contentUrl
- a content url that should be set on the working copy before
the checkin operation takes place. If null then the current working
copy content is copied back to the original node.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.@Auditable(parameters={"workingCopyNodeRef","versionProperties","contentUrl"}) org.alfresco.service.cmr.repository.NodeRef checkin(org.alfresco.service.cmr.repository.NodeRef workingCopyNodeRef, Map<String,Serializable> versionProperties, String contentUrl)
workingCopyNodeRef
- the working copy node referenceversionProperties
- the version properties. If null is passed then the original node
is NOT versioned during the checkin operation.contentUrl
- a content url that should be set on the working copy before
the checkin operation takes place. If null then the current working
copy content is copied back to the original node.@Auditable(parameters={"workingCopyNodeRef","versionProperties"}) org.alfresco.service.cmr.repository.NodeRef checkin(org.alfresco.service.cmr.repository.NodeRef workingCopyNodeRef, Map<String,Serializable> versionProperties)
workingCopyNodeRef
- the working copy node referenceversionProperties
- the version properties. If null is passed then the original node
is NOT versioned during the checkin operation.@Auditable(parameters="workingCopyNodeRef") org.alfresco.service.cmr.repository.NodeRef cancelCheckout(org.alfresco.service.cmr.repository.NodeRef workingCopyNodeRef)
The read-only lock on the original node is removed and the working copy is removed.
Note that all modification made to the working copy will be lost and the original node will remain unchanged.
A reference to the original node reference is returned.
workingCopyNodeRef
- the working copy node reference@Auditable(parameters="nodeRef") org.alfresco.service.cmr.repository.NodeRef getWorkingCopy(org.alfresco.service.cmr.repository.NodeRef nodeRef)
A null node reference is returned if the node is not checked out.
nodeRef
- a node reference@Auditable(parameters="nodeRef") org.alfresco.service.cmr.repository.NodeRef getCheckedOut(org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- the (potential) working copy@Auditable(parameters="nodeRef") boolean isWorkingCopy(org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- the (potential) working copy@Auditable(parameters="nodeRef") boolean isCheckedOut(org.alfresco.service.cmr.repository.NodeRef nodeRef)
nodeRef
- the (potentially) checked out nodeCopyright © 2005–2017 Alfresco Software. All rights reserved.