DocumentSearchResults

Name DocumentSearchResults
Usage WorkflowDocumentService
documentSearch
Type Complex

Description

An immutable data transfer object implementation of the {@link DocumentSearchResultsContract}. Instances of this
class should be constructed using the nested {@link Builder} class.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
searchResults Search Results DocumentSearchResultList Returns the unmodifiable list of search results. Each of these result objects represents a document returned
from the search.		     Many No  
criteria Criteria DocumentSearchCriteria Returns the criteria that was used to execute the search. This may not be the same criteria that was submitted
to the document search api since it is possible for criteria to be modified by backend processing of the
submitted criteria. See {@link #isCriteriaModified()} for more information.		 Required   One No  
criteriaModified Criteria Modified boolean Returns true if the criteria on this search result was modified from the original criteria submitted by the
executor of the document search. This may happen in cases where the document search implementation modifies the
given criteria. This may be possible through document search customization hooks, or may happen as part of a
process of "defaulting" certain portions of the criteria.		 Required   One No  
overThreshold Over Threshold boolean Returns true if the results of the search returned more rows then the document search framework is allowed to
return back to the caller of the api. The implementation of the document search is permitted to cap the number
of results returned and a result cap can also be specified on the criteria itself.		 Required   One No  
numberOfSecurityFilteredResults Number Of Security Filtered Results int Return the number of results that matched the criteria but are not included on this results instance because they
principal executing the document search did not have permissions to view them.		 Required   One No