org.kuali.rice.core.api.uif
Interface AttributeLookupSettings

All Known Implementing Classes:

RemotableAttributeLookupSettings, RemotableAttributeLookupSettings.Builder

public interface AttributeLookupSettings

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 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 AttributeField.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

String	getLowerBoundLabel() Returns the label to use for the lower bound of the range.
String	getLowerBoundName() Returns the name to assign to the lower bound of the range.
String	getUpperBoundLabel() Returns the label to use for the upper bound of the range.
String	getUpperBoundName() Returns the name to assign to the upper bound of the range.
Boolean	isCaseSensitive() Indicates if lookups which use this attribute should execute the lookup against this attribute in a case sensitive fashion.
boolean	isInCriteria() Returns true if this field should be included as part of the lookup criteria, false if not.
boolean	isInResults() Returns true if this field should be included in the result set of the lookup, false if not.
boolean	isLowerBoundInclusive() 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.
boolean	isRanged() Returns true if lookups against this field should be handled as a lookup operation supporting a range-based search of data against the field.
boolean	isUpperBoundInclusive() 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.

Method Detail

isInCriteria

boolean isInCriteria()

Returns true if this field should be included as part of the lookup criteria, false if not.

Returns:

true if this field should be included as part of the lookup criteria, false if not

isInResults

boolean isInResults()

Returns true if this field should be included in the result set of the lookup, false if not.

Returns:

true if this field should be included in the result set of the lookup, false if not

isRanged

boolean isRanged()

Returns true if lookups against this field should be handled as a lookup operation supporting a range-based search of data against the field.

Returns:

true if lookups against this attribute should allow for ranged lookup fields, false otherwise

getLowerBoundName

String getLowerBoundName()

Returns the name to assign to the lower bound of the range. It is important to ensure that this does not conflict with any other attribute names being used on the lookup.

Returns:

the name of the lower bound of the range

getLowerBoundLabel

String getLowerBoundLabel()

Returns the label to use for the lower bound of the range. If no label is defined, then the framework will generate one.

Returns:

the label of the lower bound of the range

isLowerBoundInclusive

boolean isLowerBoundInclusive()

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.

Returns:

true if the lower bound is inclusive, false if it is exclusive

getUpperBoundName

String getUpperBoundName()

Returns the name to assign to the upper bound of the range. It is important to ensure that this does not conflict with any other attribute names being used on the lookup.

Returns:

the name of the upper bound of the range

getUpperBoundLabel

String getUpperBoundLabel()

Returns the label to use for the upper bound of the range. If no label is defined, then the framework will generate one.

Returns:

the label of the upper bound of the range

isUpperBoundInclusive

boolean isUpperBoundInclusive()

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.

Returns:

true if the upper bound is inclusive, false if it is exclusive

isCaseSensitive

Boolean isCaseSensitive()

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.

Returns:

true if the attribute should be case sensitive on lookups, false if it should not, and null if the system-level default should be used