org.alfresco.module.vti.handler

Interface CheckOutCheckInServiceHandler

All Known Implementing Classes:

AlfrescoCheckOutCheckInServiceHandler

public interface CheckOutCheckInServiceHandler

Interface for checkOut web service handler

Author:

DmitryVas

Method Summary

Methods

Modifier and Type	Method and Description
org.alfresco.service.cmr.repository.NodeRef	checkInDocument(String fileName, org.alfresco.service.cmr.version.VersionType type, String comment, boolean lockAfterSucess) Check in provided document and creates write lock on original document
org.alfresco.service.cmr.repository.NodeRef	checkOutDocument(String fileName, boolean lockAfterSucess) Check out provided document and creates write lock on working copy
org.alfresco.service.cmr.repository.NodeRef	undoCheckOutDocument(String fileName, boolean lockAfterSucess) Undo check out on provided document and creates write lock on original document

Method Detail

checkOutDocument

org.alfresco.service.cmr.repository.NodeRef checkOutDocument(String fileName,
                                                           boolean lockAfterSucess)
                                                             throws org.alfresco.service.cmr.model.FileNotFoundException

Check out provided document and creates write lock on working copy

Parameters:

fileName - site relative url to the file

lockAfterSucess - true if original node must be locked after operation

Returns:

working copy or null if checkOut operation fails

Throws:

org.alfresco.service.cmr.model.FileNotFoundException

checkInDocument

org.alfresco.service.cmr.repository.NodeRef checkInDocument(String fileName,
                                                          org.alfresco.service.cmr.version.VersionType type,
                                                          String comment,
                                                          boolean lockAfterSucess)
                                                            throws org.alfresco.service.cmr.model.FileNotFoundException

Check in provided document and creates write lock on original document

Parameters:

fileName - site relative url to the file

type - major or minor checkin

comment - checkIn comment

lockAfterSucess - true if original node must be locked after operation

Returns:

original node or null if checkIn operation fails

Throws:

org.alfresco.service.cmr.model.FileNotFoundException

undoCheckOutDocument

org.alfresco.service.cmr.repository.NodeRef undoCheckOutDocument(String fileName,
                                                               boolean lockAfterSucess)
                                                                 throws org.alfresco.service.cmr.model.FileNotFoundException

Undo check out on provided document and creates write lock on original document

Parameters:

fileName - site relative url to the file

lockAfterSucess - true if original node must be locked after operation

Returns:

original node or null if undo checkOut operation fails

Throws:

org.alfresco.service.cmr.model.FileNotFoundException