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

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

afterUnmarshal, beforeUnmarshal, equals, hashCode, 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

getLowerBoundName

public String getLowerBoundName()

Description copied from interface: AttributeLookupSettings

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.

Specified by:

getLowerBoundName in interface AttributeLookupSettings

Returns:

the name of the lower bound of the range

getLowerBoundLabel

public String getLowerBoundLabel()

Description copied from interface: AttributeLookupSettings

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

Specified by:

getLowerBoundLabel in interface AttributeLookupSettings

Returns:

the label of the lower bound of the range

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

getUpperBoundName

public String getUpperBoundName()

Description copied from interface: AttributeLookupSettings

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.

Specified by:

getUpperBoundName in interface AttributeLookupSettings

Returns:

the name of the upper bound of the range

getUpperBoundLabel

public String getUpperBoundLabel()

Description copied from interface: AttributeLookupSettings

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

Specified by:

getUpperBoundLabel in interface AttributeLookupSettings

Returns:

the label of the upper bound of the range

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