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

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

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete, RemotableAttributeFieldContract

public final class RemotableAttributeField
extends AbstractDataTransferObject
implements RemotableAttributeFieldContract

See Also:

for more info., Serialized Form

Nested Class Summary

static class

RemotableAttributeField.Builder

Method Summary

static RemotableAttributeField	findAttribute(String attributeName, Collection<RemotableAttributeField> fields) Utility method to search a collection of attribute fields and returns a field for a give attribute name.
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 RemotableAbstractWidget>	getWidgets() The widgets for the attribute.
boolean	isForceUpperCase() Should the attribute always be in uppercase.
boolean	isRequired() Whether the attribute is a required attribute.

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

getName

public String getName()

Description copied from interface: RemotableAttributeFieldContract

The name of the attribute. Cannot be null or blank.

Specified by:

getName in interface RemotableAttributeFieldContract

Returns:

the name.

getDataType

public DataType getDataType()

Description copied from interface: RemotableAttributeFieldContract

The dataType of the attribute. Can be null.

Specified by:

getDataType in interface RemotableAttributeFieldContract

Returns:

the datatype or null.

getShortLabel

public String getShortLabel()

Description copied from interface: RemotableAttributeFieldContract

The short label of the attribute. Can be null.

Specified by:

getShortLabel in interface RemotableAttributeFieldContract

Returns:

the short label or null.

getLongLabel

public String getLongLabel()

Description copied from interface: RemotableAttributeFieldContract

The long label of the attribute. Can be null.

Specified by:

getLongLabel in interface RemotableAttributeFieldContract

Returns:

the long label or null.

getHelpSummary

public String getHelpSummary()

Description copied from interface: RemotableAttributeFieldContract

The help summary of the attribute. Can be null.

Specified by:

getHelpSummary in interface RemotableAttributeFieldContract

Returns:

the help summary or null.

getConstraintText

public String getConstraintText()

Description copied from interface: RemotableAttributeFieldContract

The help constraint of the attribute. Can be null.

Specified by:

getConstraintText in interface RemotableAttributeFieldContract

Returns:

the help constraint or null.

getHelpDescription

public String getHelpDescription()

Description copied from interface: RemotableAttributeFieldContract

The help description of the attribute. Can be null.

Specified by:

getHelpDescription in interface RemotableAttributeFieldContract

Returns:

the help description or null.

isForceUpperCase

public boolean isForceUpperCase()

Description copied from interface: RemotableAttributeFieldContract

Should the attribute always be in uppercase. Defaults to false.

Specified by:

isForceUpperCase in interface RemotableAttributeFieldContract

Returns:

force uppercase.

getMinLength

public Integer getMinLength()

Description copied from interface: RemotableAttributeFieldContract

The inclusive minimum length of the attribute. Can be null. Cannot be less than 1.

Specified by:

getMinLength in interface RemotableAttributeFieldContract

Returns:

minimum length.

getMaxLength

public Integer getMaxLength()

Description copied from interface: RemotableAttributeFieldContract

The inclusive maximum length of the attribute. Can be null. Cannot be less than 1.

Specified by:

getMaxLength in interface RemotableAttributeFieldContract

Returns:

maximum length.

getMinValue

public Double getMinValue()

Description copied from interface: RemotableAttributeFieldContract

The inclusive minimum value of the attribute. Can be null.

Specified by:

getMinValue in interface RemotableAttributeFieldContract

Returns:

minimum value.

getMaxValue

public Double getMaxValue()

Description copied from interface: RemotableAttributeFieldContract

The inclusive maximum value of the attribute. Can be null.

Specified by:

getMaxValue in interface RemotableAttributeFieldContract

Returns:

maximum value.

getRegexConstraint

public String getRegexConstraint()

Description copied from interface: RemotableAttributeFieldContract

The regex constraint to apply to the attribute field for validation. Can be null.

Specified by:

getRegexConstraint in interface RemotableAttributeFieldContract

Returns:

the constraint.

getRegexContraintMsg

public String getRegexContraintMsg()

Description copied from interface: RemotableAttributeFieldContract

The message to display if the regex constraint fails. Can be null.

Specified by:

getRegexContraintMsg in interface RemotableAttributeFieldContract

Returns:

the constraint message.

getFormatterName

public String getFormatterName()

Description copied from interface: RemotableAttributeFieldContract

The name of the formatter

Specified by:

getFormatterName in interface RemotableAttributeFieldContract

Returns:

the formatter name.

isRequired

public boolean isRequired()

Description copied from interface: RemotableAttributeFieldContract

Whether the attribute is a required attribute. Defaults to false.

Specified by:

isRequired in interface RemotableAttributeFieldContract

Returns:

whether the attribute is required.

getDefaultValues

public Collection<String> getDefaultValues()

Description copied from interface: RemotableAttributeFieldContract

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.

Specified by:

getDefaultValues in interface RemotableAttributeFieldContract

Returns:

collection of default values

getControl

public RemotableControlContract getControl()

Description copied from interface: RemotableAttributeFieldContract

The control associated with the attribute. Can be null.

Specified by:

getControl in interface RemotableAttributeFieldContract

Returns:

the control.

getWidgets

public Collection<? extends RemotableAbstractWidget> getWidgets()

Description copied from interface: RemotableAttributeFieldContract

The widgets for the attribute. Will always return an immutable list.

Specified by:

getWidgets in interface RemotableAttributeFieldContract

Returns:

collection of widgets

getAttributeLookupSettings

public AttributeLookupSettings getAttributeLookupSettings()

Description copied from interface: RemotableAttributeFieldContract

If this method returns a non-null value, it defines various settings for this attribute whenever it is used on a lookup.

Specified by:

getAttributeLookupSettings in interface RemotableAttributeFieldContract

Returns:

the attribute range configuration for this attribute, or null if this attribute should not be treated as a range in a lookup

findAttribute

public static RemotableAttributeField findAttribute(String attributeName,
                                                    Collection<RemotableAttributeField> fields)

Utility method to search a collection of attribute fields and returns a field for a give attribute name.

Parameters:

attributeName - the name of the attribute to search for. Cannot be blank or null.

fields - cannot be null.

Returns:

the attribute field or null if not found.