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

java.lang.Object
  org.kuali.rice.core.api.uif.RemotableAttributeField.Builder

All Implemented Interfaces:

ModelBuilder, RemotableAttributeFieldContract

Enclosing class:

RemotableAttributeField

public static final class RemotableAttributeField.Builder
extends Object
implements RemotableAttributeFieldContract, ModelBuilder

Method Summary

void	addToDefaultValues(String defaultValue)
RemotableAttributeField	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static RemotableAttributeField.Builder	create(RemotableAttributeFieldContract field)
static RemotableAttributeField.Builder	create(String name)
RemotableAttributeLookupSettings.Builder	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.
RemotableAbstractControl.Builder	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<RemotableAbstractWidget.Builder>	getWidgets() The widgets for the attribute.
boolean	isForceUpperCase() Should the attribute always be in uppercase.
boolean	isRequired() Whether the attribute is a required attribute.
void	setAttributeLookupSettings(RemotableAttributeLookupSettings.Builder attributeLookupSettings)
void	setConstraintText(String helpConstraint)
void	setControl(RemotableAbstractControl.Builder control)
void	setDataType(DataType dataType)
void	setDefaultValues(Collection<String> defaultValues)
void	setForceUpperCase(boolean forceUpperCase)
void	setFormatterName(String formatterName)
void	setHelpDescription(String helpDescription)
void	setHelpSummary(String helpSummary)
void	setLongLabel(String longLabel)
void	setMaxLength(Integer maxLength)
void	setMaxValue(Double maxValue)
void	setMinLength(Integer minLength)
void	setMinValue(Double minValue)
void	setName(String name)
void	setRegexConstraint(String regexConstraint)
void	setRegexContraintMsg(String regexContraintMsg)
void	setRequired(boolean required)
void	setShortLabel(String shortLabel)
void	setWidgets(Collection<RemotableAbstractWidget.Builder> widgets)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static RemotableAttributeField.Builder create(String name)

create

public static RemotableAttributeField.Builder create(RemotableAttributeFieldContract field)

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.

setName

public void setName(String 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.

setDataType

public void setDataType(DataType dataType)

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.

setShortLabel

public void setShortLabel(String shortLabel)

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.

setLongLabel

public void setLongLabel(String longLabel)

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.

setHelpSummary

public void setHelpSummary(String helpSummary)

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.

setConstraintText

public void setConstraintText(String helpConstraint)

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.

setHelpDescription

public void setHelpDescription(String helpDescription)

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.

setForceUpperCase

public void setForceUpperCase(boolean forceUpperCase)

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.

setMinLength

public void setMinLength(Integer minLength)

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.

setMaxLength

public void setMaxLength(Integer maxLength)

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.

setMinValue

public void setMinValue(Double minValue)

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.

setMaxValue

public void setMaxValue(Double maxValue)

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.

setRegexConstraint

public void setRegexConstraint(String regexConstraint)

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.

setRegexContraintMsg

public void setRegexContraintMsg(String regexContraintMsg)

getFormatterName

public String getFormatterName()

Description copied from interface: RemotableAttributeFieldContract

The name of the formatter

Specified by:

getFormatterName in interface RemotableAttributeFieldContract

Returns:

the formatter name.

setFormatterName

public void setFormatterName(String formatterName)

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.

setRequired

public void setRequired(boolean 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

setDefaultValues

public void setDefaultValues(Collection<String> defaultValues)

addToDefaultValues

public void addToDefaultValues(String defaultValue)

getAttributeLookupSettings

public RemotableAttributeLookupSettings.Builder 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

setAttributeLookupSettings

public void setAttributeLookupSettings(RemotableAttributeLookupSettings.Builder attributeLookupSettings)

getControl

public RemotableAbstractControl.Builder getControl()

Description copied from interface: RemotableAttributeFieldContract

The control associated with the attribute. Can be null.

Specified by:

getControl in interface RemotableAttributeFieldContract

Returns:

the control.

setControl

public void setControl(RemotableAbstractControl.Builder control)

getWidgets

public Collection<RemotableAbstractWidget.Builder> 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

setWidgets

public void setWidgets(Collection<RemotableAbstractWidget.Builder> widgets)

build

public RemotableAttributeField 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