DocumentSearchCriteria

Name DocumentSearchCriteria
Usage WorkflowDocumentService DocumentSearchCustomizationHandlerService
documentSearch validateCriteria customizeCriteria customizeClearCriteria customizeResults customizeResultSetConfiguration
DocumentSearchResults
Type Complex

Description

An immutable data transfer object implementation of the {@link DocumentSearchCriteriaContract}. 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
documentId Document Id String Returns the document id criteria to search against when executing the document search.     One No  
documentStatuses Document Statuses DocumentStatusList Returns an unmodifiable list of document statuses to search against when executing the document search. If there
is more than one of these, then the search should treat this as an "OR" case (i.e. search for documents with one
or more of these statuses).		     Many No  
documentStatusCategories Document Status Categories DocumentStatusCategoryList Returns an unmodifiable list of document status categories to search against when executing the document search.
If there is more than one of these, then the search should treat this as an "OR" case (i.e. search for documents
that have a status contained in one or more of these categories).		     Many No  
title Title String Returns the document title criteria to search against when executing the document search.     One No  
applicationDocumentId Application Document Id String Returns the application document id criteria to search against when executing the document search.     One No  
applicationDocumentStatus Application Document Status String Returns the application document status criteria to search against when executing the document search.     One No  
initiatorPrincipalName Initiator Principal Name String Returns the criteria for the principal name of the document initiator to search against when executing the
document search. Follows the rules for principal name criteria (see class-level documentation).		     One No  
viewerPrincipalName Viewer Principal Name String Returns the criteria for the principal name of a "viewer" of a document (someone who received an action request
related to the document) to search against when executing the document search. Follows the rules for principal
name criteria (see class-level documentation).		     One No  
groupViewerId Group Viewer Id String Returns the criteria for the id of a group who is a "viewer" of a document (a group who received an action request
related to the document) to search against when executing the document search. Group id criteria follows rules
similar to principal name criteria:


  • only literal group ids that resolve to a valid group are allowed

  • however, if the group ids don't resolve to valid groups, this simply means the search will return no results

  • "!" is allowed before a group id

  • when wanting to search on more than one viewer group id, use of "|" and "&&" is allowed, though they cannot be used together

     One No  
groupViewerName Group Viewer Name String Returns the criteria for the name of a group who is a "viewer" of a document (a group who received an action request
related to the document) to search against when executing the document search. Group name criteria follows rules
similar to principal name criteria:


  • only literal group names that resolve to a valid group are allowed

  • however, if the group names don't resolve to valid groups, this simply means the search will return no results

  • "!" is allowed before a group id

  • when wanting to search on more than one viewer group name, use of "|" and "&&" is allowed, though they cannot be used together

     One No  
approverPrincipalName Approver Principal Name String Returns the criteria for the principal name of an "approver" of a document (someone who took action against
the document) to search against when executing the document search. Follows the rules for principal name
criteria (see class-level documentation).		     One No  
routeNodeName Route Node Name String Returns the route node name criteria to search against when executing the document search. By default this will
match only documents which are at the node with the given name, unless {@link #getRouteNodeLookupLogic()} returns
a non-null value that specifies different criteria for how the route node-based lookup should be performed.		     One No  
routeNodeLookupLogic Route Node Lookup Logic RouteNodeLookupLogic Returns the logic that should be used when performing a document search against the route name. This essentially
allows for the criteria to specify whether or not it should look at documents which are currently before, exactly
at, or after the specified route node. This value only has an effect if the route node name is also defined
on this criteria.		     One No  
documentTypeName Document Type Name String Returns the document type name criteria to search against when executing the document search. If the document
type name matches a single document type exactly, this might trigger document search customizations which are
tied to that document type (assuming the document type has such customizations configured).

In order for the map of document attribute values to be properly searchable, this document type name should
result to a valid document type. This is because the document type itself defines information about custom
document attributes and the parameters around how searches against those attributes can be executed.



Note that searches against a document type name should be document type hierarchy-aware. Meaning that the
search should also return results for any documents that have document types that are children of the specified
document type name (assuming that the specified document type name is valid and not wildcarded at all).

     One No  
additionalDocumentTypeNames Additional Document Type Names StringList Returns an optional list of additional document type name criteria against which to search. The search should
effectively return all documents that have a document type name within the set of the main document type name on
the criteria as well as any additional document type names.

As with {@link #getDocumentTypeName()}, the additional document type name criteria is document type hierarchy
aware.

     Many No  
dateCreatedFrom Date Created From DateTime Returns the inclusive lower end of the date created criteria to search against when executing the document search.     One No  
dateCreatedTo Date Created To DateTime Returns the inclusive upper end of the date created criteria to search against when executing the document search.     One No  
dateLastModifiedFrom Date Last Modified From DateTime Returns the inclusive lower end of the date last modified criteria to search against when executing the document search.     One No  
dateLastModifiedTo Date Last Modified To DateTime Returns the inclusive upper end of the date last modified criteria to search against when executing the document search.     One No  
dateApprovedFrom Date Approved From DateTime Returns the inclusive lower end of the date approved criteria to search against when executing the document search.     One No  
dateApprovedTo Date Approved To DateTime Returns the inclusive upper end of the date approved criteria to search against when executing the document search.     One No  
dateFinalizedFrom Date Finalized From DateTime Returns the inclusive lower end of the date finalized criteria to search against when executing the document search.     One No  
dateFinalizedTo Date Finalized To DateTime Returns the inclusive upper end of the date finalized criteria to search against when executing the document search.     One No  
dateApplicationDocumentStatusChangedFrom Date Application Document Status Changed From DateTime Returns the inclusive lower end of the date of application document status change criteria to search against when executing the document search.     One No  
dateApplicationDocumentStatusChangedTo Date Application Document Status Changed To DateTime Returns the inclusive upper end of the date of application document status change criteria to search against when executing the document search.     One No  
documentAttributeValues Document Attribute Values Map Returns a map of document attribute values to search against when executing the document search. The key of the
map is the name of the document attribute, while the list of values contains values of those attributes to search
against. These individual attribute values support the different search operations where appropriate. The
resulting List of criteria values however should ultimately be "or"-ed together when executing the document
search.

In order for the document attribute values to be processed as part of the criteria during the search, the
{@link #getDocumentTypeName()} must return a valid name of a document type which is configured to understand the
attributes passed as part of the document attribute values map.

     One No  
saveName Save Name String Return the name under which to save this criteria so that it can be recalled and used again in the future. If no
save name is specified, then this criteria will not be saved for future use.		     One No  
startAtIndex Start At Index Integer Returns the 0-based index in the result set at which to start returning results from a document search which is
performed using this criteria. If not specified, results from the search should be returned starting at the
beginning of the result set. If this index is larger then the total number of results returned by the actual
search, then no values should be returned.		     One No  
maxResults Max Results Integer Returns the requested maximum number of documents that should be returned from a document search performed using this
criteria. If not specified, it is up to the document search implementation to decide how many results to return.
It is likely in such cases that the implementation will use a default result cap in order to prevent too many
documents from being returned.

It is important to note that this value is meant simply as a request to the document search for the number of
results to return. The implementation may return fewer results then requested if it decides to impose it's own
internal cap on results.

     One No  
isAdvancedSearch Is Advanced Search String Returns a string that indicates if a query was run in advanced mode.     One No  
searchOptions Search Options Map Returns a map of custom options for document search when either executing the document search or returning results.
The key of the map is the name of the document attribute, while the list of values contains values of those
attributes to customize against.

In order for the search options to be processed as part of the criteria during the search, a custom document
search customizer must be used to fill and process these values.

     One No