Package com.priint.pubserverapi.document

Interface DocumentQuery

All Superinterfaces:
QueryBuilder<Document>
public interface DocumentQuery extends QueryBuilder<Document>

  • Method Details

    • id

      DocumentQuery id(String id)
      Sets the ID of the Document in the query.
      Parameters:
      id - the ID of the document
      Returns:
      the current DocumentQuery instance for method chaining

    • label

      DocumentQuery label(String label)
      Sets the label of the Document in the query.
      Parameters:
      label - the label of the document
      Returns:
      the current DocumentQuery instance for method chaining

    • labelLike

      DocumentQuery labelLike(String label)
      Sets the label of the Document in the query. Restrict to documents that have a label that has the parameter value as a substring.
      Parameters:
      label - the label of the document
      Returns:
      the current DocumentQuery instance for method chaining

    • parentId

      DocumentQuery parentId(String parentId, boolean recursive)
      Sets the parent id (publication or folder) of the Document in the query.
      Parameters:
      parentId - the id of parent publication/folder
      recursive - a flag specifying whether the search should also be performed in subpublications
      Returns:
      the current DocumentQuery instance for method chaining

    • documentType

      DocumentQuery documentType(DocumentType documentType)
      Sets the document type of the Document in the query.
      Parameters:
      documentType - the type of the document
      Returns:
      the current DocumentQuery instance for method chaining

    • documentStage

      DocumentQuery documentStage(DocumentStage documentStage)
      Sets the document stage of the Document in the query.
      Parameters:
      documentStage - the stage of the document
      Returns:
      the current DocumentQuery instance for method chaining

    • deleted

      DocumentQuery deleted(boolean deleted)
      Sets the delete flag of the Document in the query. Default false - not deleted
      Parameters:
      deleted - the deletion status of the document
      Returns:
      the current DocumentQuery instance for method chaining

    • isDocumentTemplate

      DocumentQuery isDocumentTemplate(boolean isDocumentTemplate)
      Sets the document template flag of the Document in the query. Default false - regular document
      Parameters:
      isDocumentTemplate - a flag specifying whether the document is a document template
      Returns:
      the current DocumentQuery instance for method chaining

    • sourceDocumentId

      DocumentQuery sourceDocumentId(String sourceDocumentId)
      Sets the source document ID of the Document in the query.
      Parameters:
      sourceDocumentId - the ID of the source document of the document
      Returns:
      the current DocumentQuery instance for method chaining

    • documentTemplateId

      DocumentQuery documentTemplateId(String documentTemplateId)
      Sets the document template ID of the Document in the query.
      Parameters:
      documentTemplateId - the ID of the document template of the document
      Returns:
      the current DocumentQuery instance for method chaining

    • foreignSystemKey

      DocumentQuery foreignSystemKey(String foreignSystemKey)
      Sets theforeign system key of the Document in the query.
      Parameters:
      foreignSystemKey - the foreign system key of the document
      Returns:
      the current DocumentQuery instance for method chaining