org.alfresco.service.cmr.coci

Interface CheckOutCheckInService

All Known Implementing Classes:

CheckOutCheckInServiceImpl

@AlfrescoPublicApi
public interface CheckOutCheckInService

Version operations service interface

Author:

Roy Wetherall

Method Summary

Methods

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

Method Detail

checkout

@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)

Checks out the given node placing a working copy in the destination specified.

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.

Parameters:

nodeRef - a reference to the node to checkout

destinationParentNodeRef - the destination node reference for the working copy

destinationAssocTypeQName - the destination child assoc type for the working copy

destinationAssocQName - the destination child assoc qualified name for the working copy

Returns:

node reference to the created working copy

checkout

@Auditable(parameters="nodeRef")
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.

Parameters:

nodeRef - a reference to the node to checkout

Returns:

a node reference to the created working copy

See Also:

checkout(NodeRef, NodeRef, QName, QName)

checkin

@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)

Checks in the working node specified.

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.

Parameters:

workingCopyNodeRef - the working copy node reference

versionProperties - 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.

Returns:

the node reference to the original node, updated with the checked in state

checkin

@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)

By default the checked in node is not keep checked in.

Parameters:

workingCopyNodeRef - the working copy node reference

versionProperties - 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.

Returns:

the node reference to the original node, updated with the checked in state

See Also:

VersionOperationsService#checkin(NodeRef, HashMap, String, boolean)

checkin

@Auditable(parameters={"workingCopyNodeRef","versionProperties"})
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.

Parameters:

workingCopyNodeRef - the working copy node reference

versionProperties - the version properties. If null is passed then the original node is NOT versioned during the checkin operation.

Returns:

the node reference to the original node, updated with the checked in state

See Also:

VersionOperationsService#checkin(NodeRef, HashMap, String)

cancelCheckout

@Auditable(parameters="workingCopyNodeRef")
org.alfresco.service.cmr.repository.NodeRef cancelCheckout(org.alfresco.service.cmr.repository.NodeRef workingCopyNodeRef)

Cancels the checkout for a given working copy.

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.

Parameters:

workingCopyNodeRef - the working copy node reference

Returns:

the original node reference

getWorkingCopy

@Auditable(parameters="nodeRef")
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.

A null node reference is returned if the node is not checked out.

Parameters:

nodeRef - a node reference

Returns:

the working copy node reference or null if none.

getCheckedOut

@Auditable(parameters="nodeRef")
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.

A null node reference is returned if the node is not a working copy.

Parameters:

nodeRef - the (potential) working copy

Returns:

the original (source) node or null if it is not a working copy

isWorkingCopy

@Auditable(parameters="nodeRef")
boolean isWorkingCopy(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Determine if a node is a working copy or not

Parameters:

nodeRef - the (potential) working copy

Returns:

true if the node is a working copy otherwise false

isCheckedOut

@Auditable(parameters="nodeRef")
boolean isCheckedOut(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Determine if a node has been checked out or not

Parameters:

nodeRef - the (potentially) checked out node

Returns:

true if the node has been checked out otherwise false