org.alfresco.repo.coci
Class CheckOutCheckInServiceImpl

java.lang.Object
  extended by org.alfresco.repo.coci.CheckOutCheckInServiceImpl
All Implemented Interfaces:
CheckOutCheckInService

public class CheckOutCheckInServiceImpl
extends java.lang.Object
implements CheckOutCheckInService

Check out check in service implementation


Constructor Summary
CheckOutCheckInServiceImpl()
           
 
Method Summary
 NodeRef cancelCheckout(NodeRef workingCopyNodeRef)
          Cancels the checkout for a given working copy.
 NodeRef checkin(NodeRef workingCopyNodeRef, java.util.Map versionProperties)
          If no content url is specified then current content set on the working copy is understood to be current.
 NodeRef checkin(NodeRef workingCopyNodeRef, java.util.Map versionProperties, java.lang.String contentUrl)
          By default the checked in node is not keep checked in.
 NodeRef checkin(NodeRef workingCopyNodeRef, java.util.Map versionProperties, java.lang.String contentUrl, boolean keepCheckedOut)
          Checks in the working node specified.
 NodeRef checkout(NodeRef nodeRef)
          Checks out the working copy of the node into the same parent node with the same child associations details.
 NodeRef checkout(NodeRef nodeRef, NodeRef destinationParentNodeRef, QName destinationAssocTypeQName, QName destinationAssocQName)
          Checks out the given node placing a working copy in the destination specified.
 java.lang.String createWorkingCopyName(java.lang.String name)
          Create working copy name
 NodeRef getWorkingCopy(NodeRef nodeRef)
          Helper method to retrieve the working copy node reference for a checked out node.
 java.lang.String getWorkingCopyLabel()
          Get the working copy label.
 void init()
          Initialise method
 void setAuthenticationService(AuthenticationService authenticationService)
          Sets the authentication service
 void setCopyService(CopyService copyService)
          Sets the copy service
 void setFileFolderService(FileFolderService fileFolderService)
          Set the file folder service
 void setLockService(LockService lockService)
          Sets the lock service
 void setNodeService(NodeService nodeService)
          Set the node service
 void setPolicyComponent(PolicyComponent policyComponent)
           
 void setSearchService(SearchService searchService)
          Set the search service
 void setVersionableAspect(VersionableAspect versionableAspect)
          Sets the versionable aspect behaviour implementation
 void setVersionService(VersionService versionService)
          Set the version service
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CheckOutCheckInServiceImpl

public CheckOutCheckInServiceImpl()
Method Detail

setNodeService

public void setNodeService(NodeService nodeService)
Set the node service

Parameters:
nodeService - the node service

setVersionService

public void setVersionService(VersionService versionService)
Set the version service

Parameters:
versionService - the version service

setLockService

public void setLockService(LockService lockService)
Sets the lock service

Parameters:
lockService - the lock service

setCopyService

public void setCopyService(CopyService copyService)
Sets the copy service

Parameters:
copyService - the copy service

setAuthenticationService

public void setAuthenticationService(AuthenticationService authenticationService)
Sets the authentication service

Parameters:
authenticationService - the authentication service

setSearchService

public void setSearchService(SearchService searchService)
Set the search service

Parameters:
searchService - the search service

setFileFolderService

public void setFileFolderService(FileFolderService fileFolderService)
Set the file folder service

Parameters:
fileFolderService - the file folder service

setVersionableAspect

public void setVersionableAspect(VersionableAspect versionableAspect)
Sets the versionable aspect behaviour implementation

Parameters:
versionableAspect - the versionable aspect behaviour implementation

setPolicyComponent

public void setPolicyComponent(PolicyComponent policyComponent)
Parameters:
policyComponent - policy component

init

public void init()
Initialise method


checkout

public NodeRef checkout(NodeRef nodeRef,
                        NodeRef destinationParentNodeRef,
                        QName destinationAssocTypeQName,
                        QName destinationAssocQName)
Description copied from interface: CheckOutCheckInService
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.

Specified by:
checkout in interface CheckOutCheckInService
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
See Also:
CheckOutCheckInService.checkout(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, org.alfresco.service.namespace.QName)

checkout

public NodeRef checkout(NodeRef nodeRef)
Description copied from interface: CheckOutCheckInService
Checks out the working copy of the node into the same parent node with the same child associations details.

Specified by:
checkout in interface CheckOutCheckInService
Parameters:
nodeRef - a reference to the node to checkout
Returns:
a node reference to the created working copy
See Also:
CheckOutCheckInService.checkout(org.alfresco.service.cmr.repository.NodeRef)

checkin

public NodeRef checkin(NodeRef workingCopyNodeRef,
                       java.util.Map versionProperties,
                       java.lang.String contentUrl,
                       boolean keepCheckedOut)
Description copied from interface: CheckOutCheckInService
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 version properties are provided the original node will be versioned and updated accordingly.

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.

Specified by:
checkin in interface CheckOutCheckInService
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
See Also:
org.alfresco.repo.version.operations.VersionOperationsService#checkin(org.alfresco.repo.ref.NodeRef, Map, java.lang.String, boolean)

checkin

public NodeRef checkin(NodeRef workingCopyNodeRef,
                       java.util.Map versionProperties,
                       java.lang.String contentUrl)
Description copied from interface: CheckOutCheckInService
By default the checked in node is not keep checked in.

Specified by:
checkin in interface CheckOutCheckInService
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:
CheckOutCheckInService.checkin(org.alfresco.service.cmr.repository.NodeRef, Map, java.lang.String)

checkin

public NodeRef checkin(NodeRef workingCopyNodeRef,
                       java.util.Map versionProperties)
Description copied from interface: CheckOutCheckInService
If no content url is specified then current content set on the working copy is understood to be current.

Specified by:
checkin in interface CheckOutCheckInService
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:
CheckOutCheckInService.checkin(org.alfresco.service.cmr.repository.NodeRef, Map)

cancelCheckout

public NodeRef cancelCheckout(NodeRef workingCopyNodeRef)
Description copied from interface: CheckOutCheckInService
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.

Specified by:
cancelCheckout in interface CheckOutCheckInService
Parameters:
workingCopyNodeRef - the working copy node reference
Returns:
the original node reference
See Also:
CheckOutCheckInService.cancelCheckout(org.alfresco.service.cmr.repository.NodeRef)

getWorkingCopy

public NodeRef getWorkingCopy(NodeRef nodeRef)
Description copied from interface: CheckOutCheckInService
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.

Specified by:
getWorkingCopy in interface CheckOutCheckInService
Parameters:
nodeRef - a node reference
Returns:
the working copy node reference or null if none.
See Also:
CheckOutCheckInService.getWorkingCopy(org.alfresco.service.cmr.repository.NodeRef)

createWorkingCopyName

public java.lang.String createWorkingCopyName(java.lang.String name)
Create working copy name

Parameters:
name - name
Returns:
working copy name

getWorkingCopyLabel

public java.lang.String getWorkingCopyLabel()
Get the working copy label.

Returns:
the working copy label


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.