Package com.priint.pubserverapi.document.lock

Interface LockedDocumentsQuery

All Superinterfaces:

QueryBuilder<DocumentLocks>

public interface LockedDocumentsQuery
extends QueryBuilder<DocumentLocks>

Interface for building queries to retrieve DocumentLocks entities.

This interface extends QueryBuilder and provides methods to construct queries based on attributes of a DocumentLocks, such as ID, document ID, user information, and timestamps. It supports method chaining for constructing complex queries.

See Also:

• DocumentLocks
• QueryBuilder

Method Summary

Modifier and Type	Method	Description
LockedDocumentsQuery	documentId(DocumentId documentId)	Sets the document ID associated with the DocumentLocks in the query.
LockedDocumentsQuery	lockingSessionId(String lockingSessionId)	Sets the project associated with the DocumentLocks in the query.
LockedDocumentsQuery	openedBy(String openedBy)	Sets the user who acquired the DocumentLocks in the query.
LockedDocumentsQuery	openedFrom(LocalDateTime openedFrom)	Sets the starting timestamp for when some of the DocumentLocks were acquired.
LockedDocumentsQuery	openedUntil(LocalDateTime openedUntil)	Sets the ending timestamp for when some of the DocumentLocks were acquired.
LockedDocumentsQuery	project(String project)	Sets the project associated with the DocumentLocks in the query.
LockedDocumentsQuery	tenant(String tenant)	Sets the project associated with the DocumentLocks in the query.

Methods inherited from interface com.priint.pubserverapi.query.QueryBuilder

list, singleResult

Method Details

documentId

LockedDocumentsQuery documentId(DocumentId documentId)

Sets the document ID associated with the DocumentLocks in the query.

Parameters:

documentId - the ID of the document associated with the checked-out record

Returns:

the current LockedDocumentsQuery instance for method chaining

tenant

LockedDocumentsQuery tenant(String tenant)

Sets the project associated with the DocumentLocks in the query.

Parameters:

tenant - identifier of the tenant the locked document belongs to

Returns:

the current LockedDocumentsQuery instance for method chaining

project

LockedDocumentsQuery project(String project)

Sets the project associated with the DocumentLocks in the query.

Parameters:

project - identifier of the project the checked-out document belongs to

Returns:

the current LockedDocumentsQuery instance for method chaining

openedBy

LockedDocumentsQuery openedBy(String openedBy)

Sets the user who acquired the DocumentLocks in the query.

Parameters:

openedBy - the username or identifier of the user who opened the document

Returns:

the current LockedDocumentsQuery instance for method chaining

openedFrom

LockedDocumentsQuery openedFrom(LocalDateTime openedFrom)

Sets the starting timestamp for when some of the DocumentLocks were acquired.

Parameters:

openedFrom - the start time to filter documents opened after this time

Returns:

the current LockedDocumentsQuery instance for method chaining

openedUntil

LockedDocumentsQuery openedUntil(LocalDateTime openedUntil)

Sets the ending timestamp for when some of the DocumentLocks were acquired.

Parameters:

openedUntil - the end time to filter documents opened before this time

Returns:

the current LockedDocumentsQuery instance for method chaining

lockingSessionId

LockedDocumentsQuery lockingSessionId(String lockingSessionId)

Sets the project associated with the DocumentLocks in the query.

Parameters:

lockingSessionId - identifier of the session that created the lock for the document

Returns:

the current LockedDocumentsQuery instance for method chaining