Package com.priint.pubserverapi.document

Interface CheckedOutDocumentsServiceLocal

public interface CheckedOutDocumentsServiceLocal

Interface for a service managing checked-out documents.

Provides methods for creating queries, retrieving specific checked-out documents, and unlocking documents. This interface is designed for local usage within the application.

See Also:

• CheckedOutDocumentsQuery
• CheckedOutDocument
• CheckedOutDocumentId
• UnlockStatus

Method Summary

Modifier and Type	Method	Description
CheckedOutDocumentsQuery	createCheckedOutDocumentQuery()	Creates a new CheckedOutDocumentsQuery instance for querying checked-out documents.
Optional<CheckedOutDocument>	getCheckedOutDocumentById(CheckedOutDocumentId checkedOutDocumentId)	Retrieves a checked-out document by its unique identifier.
UnlockStatus	unLock(DocumentId documentId)	Unlocks a document that has been checked out, making it available for editing or other operations.

Method Details

createCheckedOutDocumentQuery

CheckedOutDocumentsQuery createCheckedOutDocumentQuery()

Creates a new CheckedOutDocumentsQuery instance for querying checked-out documents.

Returns:

a new CheckedOutDocumentsQuery instance

getCheckedOutDocumentById

Optional<CheckedOutDocument> getCheckedOutDocumentById(CheckedOutDocumentId checkedOutDocumentId)

Retrieves a checked-out document by its unique identifier.

Parameters:

checkedOutDocumentId - the unique identifier of the checked-out document

Returns:

an Optional containing the CheckedOutDocument if found, or an empty Optional if no document is found with the given ID

unLock

UnlockStatus unLock(DocumentId documentId)

Unlocks a document that has been checked out, making it available for editing or other operations.

Parameters:

documentId - the unique identifier of the document to unlock

Returns:

the UnlockStatus indicating the result of the unlock operation