Interface CheckedoutDocumentsServiceLocal
-
public interface CheckedoutDocumentsServiceLocalLocal interface for the CheckedoutDocuments service from the Planner API
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CheckedoutDocumentgetCheckedoutDocument(java.lang.String id)Returns the checked out document at the specified IDjava.util.List<CheckedoutDocument>getCheckedoutDocuments(CheckedoutDocumentsFilter filter)Returns the list of checked out documents fulfilling the search criteria passed as parameterbooleanunlockCheckedoutDocument(java.lang.String id)Unlocks (closes) the checked out document at the specified ID
-
-
-
Method Detail
-
getCheckedoutDocument
CheckedoutDocument getCheckedoutDocument(java.lang.String id) throws ServiceException
Returns the checked out document at the specified ID- Parameters:
id- document id- Returns:
- the checked out document
- Throws:
PubServerExceptionServiceException
-
unlockCheckedoutDocument
boolean unlockCheckedoutDocument(java.lang.String id) throws ServiceExceptionUnlocks (closes) the checked out document at the specified ID- Parameters:
id- document ID- Returns:
- result as boolean
- Throws:
ServiceException
-
getCheckedoutDocuments
java.util.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
-
-