RemotableAttributeLookupSettings.Builder (Rice 2.5.5-SNAPSHOT API)

java.lang.Object
- org.kuali.rice.core.api.uif.RemotableAttributeLookupSettings.Builder

All Implemented Interfaces:

Serializable, ModelBuilder, AttributeLookupSettings

Enclosing class:

RemotableAttributeLookupSettings
```
public static final class RemotableAttributeLookupSettings.Builder
extends Object
implements Serializable, ModelBuilder, AttributeLookupSettings
```
A builder which can be used to construct RemotableAttributeLookupSettings instances. Enforces the constraints of the AttributeLookupSettings.

See Also:
Serialized Form

Method Summary

Methods
Modifier and Type	Method and Description
`RemotableAttributeLookupSettings`	`build()` Returns an instance of the object being built by this builder based on the current state of the builder.
`static RemotableAttributeLookupSettings.Builder`	`create()`
`static RemotableAttributeLookupSettings.Builder`	`create(AttributeLookupSettings contract)`
`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()`
`void`	`setCaseSensitive(Boolean caseSensitive)`
`void`	`setInCriteria(boolean inCriteria)`
`void`	`setInResults(boolean inResults)`
`void`	`setLowerBoundInclusive(boolean lowerBoundInclusive)`
`void`	`setLowerDatePicker(Boolean b)`
`void`	`setLowerLabel(String s)`
`void`	`setRanged(boolean ranged)`
`void`	`setUpperBoundInclusive(boolean upperBoundInclusive)`
`void`	`setUpperDatePicker(Boolean b)`
`void`	`setUpperLabel(String s)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static RemotableAttributeLookupSettings.Builder create()
```
  - create
```
public static RemotableAttributeLookupSettings.Builder create(AttributeLookupSettings contract)
```
  - build
```
public RemotableAttributeLookupSettings build()
```
    Description copied from interface: ModelBuilder
    
    Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;
    
    Specified by:
    
    build in interface ModelBuilder
    
    Returns:
    an instance of the object being built by this builder, should never return null
  - 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
  - setInCriteria
```
public void setInCriteria(boolean inCriteria)
```
  - setInResults
```
public void setInResults(boolean inResults)
```
  - setRanged
```
public void setRanged(boolean ranged)
```
  - setLowerBoundInclusive
```
public void setLowerBoundInclusive(boolean lowerBoundInclusive)
```
  - setUpperBoundInclusive
```
public void setUpperBoundInclusive(boolean upperBoundInclusive)
```
  - setCaseSensitive
```
public void setCaseSensitive(Boolean caseSensitive)
```
  - setLowerLabel
```
public void setLowerLabel(String s)
```
  - setUpperLabel
```
public void setUpperLabel(String s)
```
  - setLowerDatePicker
```
public void setLowerDatePicker(Boolean b)
```
  - setUpperDatePicker
```
public void setUpperDatePicker(Boolean b)
```

Class RemotableAttributeLookupSettings.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

create

build

isInCriteria

isInResults

isRanged

isLowerBoundInclusive

isUpperBoundInclusive

isCaseSensitive

getLowerLabel

getUpperLabel

isLowerDatePicker

isUpperDatePicker

setInCriteria

setInResults

setRanged

setLowerBoundInclusive

setUpperBoundInclusive

setCaseSensitive

setLowerLabel

setUpperLabel

setLowerDatePicker

setUpperDatePicker