AttributeLookupSettings

Name AttributeLookupSettings
Usage DocumentSearchCustomizationHandlerService
RemotableAttributeField
Type Complex

Description

Defines configuration for an attribute which may be used as part of a lookups. This includes indicating if the
field is displayed in the lookup criteria or lookup result set, as well as defining information about this field
if it used as part of a range-based lookup.

The range bounds allows the party executing the lookup against this attribute to enter a value for both ends
(lower and upper bounds) in order to determine if the attribute is "between" those two values.



Note that an attribute range only makes sense if the {@code DataType} of the attribute is
a date or numerical data type. The consumer of these settings is free to ignore the given
attribute range information if it does not believe it is possible to successfully present a range-based
lookup option based on the data type (or other settings) of the {@code AttributeField}.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
inCriteria In Criteria boolean Returns true if this field should be included as part of the lookup criteria, false if not.     One No  
inResults In Results boolean Returns true if this field should be included in the result set of the lookup, false if not.     One No  
ranged Ranged boolean Returns true if lookups against this field should be handled as a lookup operation supporting a range-based
search of data against the field.		     One No  
lowerBoundInclusive Lower Bound Inclusive boolean Returns true if the lower bound should be treated as inclusive when executing a ranged
lookup against the attribute, false if it should be treated as exclusive.		     One No  
upperBoundInclusive Upper Bound Inclusive boolean Returns true if the upper bound should be treated as inclusive when executing a ranged
lookup against the attribute, false if it should be treated as exclusive.		     One No  
caseSensitive Case Sensitive Boolean Indicates if lookups which use this attribute should execute the lookup against this attribute
in a case sensitive fashion. If this method returns null, it means that the system-level
default for case sensitivity of attributes on lookups should be used.		     One No  
lowerLabel Lower Label String ???     One No  
upperLabel Upper Label String ???     One No  
lowerDatePicker Lower Date Picker Boolean ???     One No  
upperDatePicker Upper Date Picker Boolean ???     One No