RemotableAttributeFieldContract (Rice 2.1.13 API)

All Known Implementing Classes:

RemotableAttributeField, RemotableAttributeField.Builder
```
public interface RemotableAttributeFieldContract
```
This interface describes an attribute. It can be considered the definition for an attribute. It also contains preferred rendering instructions for an attribute. ie when rendering an attribute in a user interface use this control with these widgets.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AttributeLookupSettings`	`getAttributeLookupSettings()` If this method returns a non-null value, it defines various settings for this attribute whenever it is used on a lookup.
`String`	`getConstraintText()` The help constraint of the attribute.
`RemotableControlContract`	`getControl()` The control associated with the attribute.
`DataType`	`getDataType()` The dataType of the attribute.
`Collection<String>`	`getDefaultValues()` The default values for the attribute.
`String`	`getFormatterName()` The name of the formatter
`String`	`getHelpDescription()` The help description of the attribute.
`String`	`getHelpSummary()` The help summary of the attribute.
`String`	`getLongLabel()` The long label of the attribute.
`Integer`	`getMaxLength()` The inclusive maximum length of the attribute.
`Double`	`getMaxValue()` The inclusive maximum value of the attribute.
`Integer`	`getMinLength()` The inclusive minimum length of the attribute.
`Double`	`getMinValue()` The inclusive minimum value of the attribute.
`String`	`getName()` The name of the attribute.
`String`	`getRegexConstraint()` The regex constraint to apply to the attribute field for validation.
`String`	`getRegexContraintMsg()` The message to display if the regex constraint fails.
`String`	`getShortLabel()` The short label of the attribute.
`Collection<? extends RemotableWidgetContract>`	`getWidgets()` The widgets for the attribute.
`boolean`	`isForceUpperCase()` Should the attribute always be in uppercase.
`boolean`	`isRequired()` Whether the attribute is a required attribute.

- Method Detail
  - getName
```
String getName()
```
    The name of the attribute. Cannot be null or blank.
    
    Returns:
    
    the name.
  - getDataType
```
DataType getDataType()
```
    The dataType of the attribute. Can be null.
    
    Returns:
    
    the datatype or null.
  - getShortLabel
```
String getShortLabel()
```
    The short label of the attribute. Can be null.
    
    Returns:
    
    the short label or null.
  - getLongLabel
```
String getLongLabel()
```
    The long label of the attribute. Can be null.
    
    Returns:
    
    the long label or null.
  - getHelpSummary
```
String getHelpSummary()
```
    The help summary of the attribute. Can be null.
    
    Returns:
    
    the help summary or null.
  - getConstraintText
```
String getConstraintText()
```
    The help constraint of the attribute. Can be null.
    
    Returns:
    
    the help constraint or null.
  - getHelpDescription
```
String getHelpDescription()
```
    The help description of the attribute. Can be null.
    
    Returns:
    
    the help description or null.
  - isForceUpperCase
```
boolean isForceUpperCase()
```
    Should the attribute always be in uppercase. Defaults to false.
    
    Returns:
    
    force uppercase.
  - getMinLength
```
Integer getMinLength()
```
    The inclusive minimum length of the attribute. Can be null. Cannot be less than 1.
    
    Returns:
    
    minimum length.
  - getMaxLength
```
Integer getMaxLength()
```
    The inclusive maximum length of the attribute. Can be null. Cannot be less than 1.
    
    Returns:
    
    maximum length.
  - getMinValue
```
Double getMinValue()
```
    The inclusive minimum value of the attribute. Can be null.
    
    Returns:
    
    minimum value.
  - getMaxValue
```
Double getMaxValue()
```
    The inclusive maximum value of the attribute. Can be null.
    
    Returns:
    
    maximum value.
  - getRegexConstraint
```
String getRegexConstraint()
```
    The regex constraint to apply to the attribute field for validation. Can be null.
    
    Returns:
    
    the constraint.
  - getRegexContraintMsg
```
String getRegexContraintMsg()
```
    The message to display if the regex constraint fails. Can be null.
    
    Returns:
    
    the constraint message.
  - getFormatterName
```
String getFormatterName()
```
    The name of the formatter
    
    Returns:
    
    the formatter name.
  - isRequired
```
boolean isRequired()
```
    Whether the attribute is a required attribute. Defaults to false.
    
    Returns:
    
    whether the attribute is required.
  - getDefaultValues
```
Collection<String> getDefaultValues()
```
    The default values for the attribute. In the case where the "control" associated with the attribute only allows a single default value then only one item in this list will be used. Cannot be null. Will always return an immutable list.
    
    Returns:
    
    collection of default values
  - getControl
```
RemotableControlContract getControl()
```
    The control associated with the attribute. Can be null.
    
    Returns:
    
    the control.
  - getWidgets
```
Collection<? extends RemotableWidgetContract> getWidgets()
```
    The widgets for the attribute. Will always return an immutable list.
    
    Returns:
    
    collection of widgets
  - getAttributeLookupSettings
```
AttributeLookupSettings getAttributeLookupSettings()
```
    If this method returns a non-null value, it defines various settings for this attribute whenever it is used on a lookup.
    
    Returns:
    
    the attribute range configuration for this attribute, or null if this attribute should not be treated as a range in a lookup

Interface RemotableAttributeFieldContract

Method Summary

Method Detail

getName

getDataType

getShortLabel

getLongLabel

getHelpSummary

getConstraintText

getHelpDescription

isForceUpperCase

getMinLength

getMaxLength

getMinValue

getMaxValue

getRegexConstraint

getRegexContraintMsg

getFormatterName

isRequired

getDefaultValues

getControl

getWidgets

getAttributeLookupSettings