Package com.priint.pubserver.plannerapi.interfaces

Interface CheckedoutDocumentsServiceLocal

public interface CheckedoutDocumentsServiceLocal

Local interface for the CheckedoutDocuments service from the Planner API

Method Summary

Modifier and Type	Method	Description
CheckedoutDocument	getCheckedoutDocument(String id)	Returns the checked out document at the specified ID
List<CheckedoutDocument>	getCheckedoutDocuments(CheckedoutDocumentsFilter filter)	Returns the list of checked out documents fulfilling the search criteria passed as parameter
boolean	unlockCheckedoutDocument(String id)	Unlocks (closes) the checked out document at the specified ID

Method Details

getCheckedoutDocument

CheckedoutDocument getCheckedoutDocument(String id)
                                  throws ServiceException

Returns the checked out document at the specified ID

Parameters:

id - document id

Returns:

the checked out document

Throws:

PubServerException

ServiceException

unlockCheckedoutDocument

boolean unlockCheckedoutDocument(String id)
                          throws ServiceException

Unlocks (closes) the checked out document at the specified ID

Parameters:

id - document ID

Returns:

result as boolean

Throws:

ServiceException

getCheckedoutDocuments

List<CheckedoutDocument> getCheckedoutDocuments(CheckedoutDocumentsFilter filter)
                                         throws ServiceException

Returns the list of checked out documents fulfilling the search criteria passed as parameter

Parameters:

filter - search criteria in CheckedoutDocumentsFilter object

Returns:

the list of checked out documents

Throws:

ServiceException

See Also:

• CheckedoutDocumentsFilter