DocumentSearchResultSetConfiguration

Name DocumentSearchResultSetConfiguration
Usage DocumentSearchCustomizationHandlerService
customizeResultSetConfiguration
Type Complex

Description

An immutable data transfer object implementation of the {@link DocumentSearchResultSetConfigurationContract}.
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
overrideSearchableAttributes Override Searchable Attributes boolean Returns true if the custom field names returned by {@link #getCustomFieldNamesToAdd()} should be used to define
the order of searchable attributes as well as additional custom additional fields. Returns false if any
searchable attribute values should be included in the result set according to their existing configuration.		 Required   One No  
customFieldNamesToAdd Custom Field Names To Add StringList Returns a list of field names of custom fields representing document attributes which should be added to the
result set. This may contains fields that are defined in {@link #getAdditionalAttributeFields()} or also fields
defined as part of a {@link org.kuali.rice.kew.framework.document.attribute.SearchableAttribute} (see {@code isOverrideSearchableAttributes()}).		     Many No  
standardResultFieldsToRemove Standard Result Fields To Remove StandardResultFieldList Returns a list of the standard (built-in) document search result fields which should not be displayed in the
result set. The document search implementation should do it's best to honor the request to remove standard
fields from the result set, but it is free to ignore such requests if needed. An example of this would be a
preference for the implementation of document search that requires certain result set fields to remain (such as
the document id and route log which is usually recommended to display).		     Many No  
additionalAttributeFields Additional Attribute Fields RemotableAttributeFieldList Gets attribute field definitions for additional attributes that may be displayed in the result set. This simply
defines the attribute field definition for each of these fields, their inclusion here does not necessarily mean
they will be visible in the result set. This is controlled primarily by {@link #getCustomFieldNamesToAdd()}.		     Many No