Package org.kuali.rice.kew.api.document.search

Interface DocumentSearchResultContract

All Known Implementing Classes:
DocumentSearchResult, DocumentSearchResult.Builder
public interface DocumentSearchResultContract
Defines the contract for a single document result from execution of a document search. This serves to package the actual document with it's document attributes.

  • Method Details

    • getDocument

      DocumentContract getDocument()
      Returns the document represented by this result. This should include all information available on the DocumentContract with the exception of document variables. Even if a document has variables defined they will not be included on the document returned from this method.
      Returns:
      the document represented by this result, this will never be null

    • getDocumentAttributes

      List<? extends DocumentAttributeContract> getDocumentAttributes()
      Returns an unmodifiable list of objects implementing the DocumentAttributeContract interface. These define the various document attributes that have been indexed for the document represented by this result.
      Returns:
      an unmodifiable list containing the document attribute values associated with the document represented by this result, this will never be null but may be empty