org.kuali.rice.core.api.uif
Class RemotableAttributeLookupSettings

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.core.api.uif.RemotableAttributeLookupSettings

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete, AttributeLookupSettings

public final class RemotableAttributeLookupSettings
extends AbstractDataTransferObject
implements AttributeLookupSettings

See Also:

Serialized Form

Nested Class Summary

static class

RemotableAttributeLookupSettings.Builder A builder which can be used to construct RemotableAttributeLookupSettings instances.

Method Summary

String	getLowerLabel()
String	getUpperLabel()
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	isLowerDatePicker()
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.
Boolean	isUpperDatePicker()

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

isInCriteria

public boolean isInCriteria()

Description copied from interface: AttributeLookupSettings

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

Specified by:

isInCriteria in interface AttributeLookupSettings

Returns:

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

isInResults

public boolean isInResults()

Description copied from interface: AttributeLookupSettings

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

Specified by:

isInResults in interface AttributeLookupSettings

Returns:

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

isRanged

public boolean isRanged()

Description copied from interface: AttributeLookupSettings

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

Specified by:

isRanged in interface AttributeLookupSettings

Returns:

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

isLowerBoundInclusive

public boolean isLowerBoundInclusive()

Description copied from interface: AttributeLookupSettings

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.

Specified by:

isLowerBoundInclusive in interface AttributeLookupSettings

Returns:

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

isUpperBoundInclusive

public boolean isUpperBoundInclusive()

Description copied from interface: AttributeLookupSettings

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.

Specified by:

isUpperBoundInclusive in interface AttributeLookupSettings

Returns:

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

isCaseSensitive

public Boolean isCaseSensitive()

Description copied from interface: AttributeLookupSettings

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.

Specified by:

isCaseSensitive in interface AttributeLookupSettings

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

getLowerLabel

public String getLowerLabel()

Specified by:

getLowerLabel in interface AttributeLookupSettings

Returns:

an explicit label for the lower bound field

getUpperLabel

public String getUpperLabel()

Specified by:

getUpperLabel in interface AttributeLookupSettings

Returns:

an explicit label for the upper bound field

isLowerDatePicker

public Boolean isLowerDatePicker()

Specified by:

isLowerDatePicker in interface AttributeLookupSettings

Returns:

whether to display a datepicker for the lower bound

isUpperDatePicker

public Boolean isUpperDatePicker()

Specified by:

isUpperDatePicker in interface AttributeLookupSettings

Returns:

whether to display a datepicker for the upper bound