org.kuali.student.r2.common.datadictionary.dto
Class AttributeDefinitionInfo

java.lang.Object
  org.kuali.student.r2.common.datadictionary.dto.AttributeDefinitionInfo

All Implemented Interfaces:

Serializable, AttributeDefinitionInfc

public class AttributeDefinitionInfo
extends Object
implements AttributeDefinitionInfc, Serializable

See Also:

Serialized Form

Nested Class Summary

static class

AttributeDefinitionInfo.Builder

Constructor Summary

AttributeDefinitionInfo()
Constructs a new AttributeDefinitionInfo.

AttributeDefinitionInfo(AttributeDefinitionInfc attrDef)
Constructs a new AttributeDefinitionInfo from an AttributeDefinition.

Method Summary

String	getChildEntryName()
String	getCustomValidatorClass() Class to do custom validation
DataType	getDataType() The type of data this attribite (field) holds.
String	getDescription() The description element is used to provide a long description of the attribute or collection.
String	getDisplayLabelAttribute() The displayLabelAttribute element is used to indicate that the label and short label should be obtained from another attribute.
String	getExclusiveMin() The exclusiveMin element determines the minimum allowable value for data entry editing purposes.
String	getFormatterClass() The formatterClass element is used when custom formatting is required for display of the field value.
String	getInclusiveMax() The inclusiveMax element determines the maximum allowable value for data entry editing purposes.
Boolean	getIsForceUppercase() Converts user entry to uppercase and always display database value as uppercase.
Boolean	getIsRequired() The required element allows values of "true" or "false".
Boolean	getIsUnique() Similar to a db column that is flagged as unique, the value is unique across all data objects of that type
String	getLabel() The label element is the field or collection name that will be shown on inquiry and maintenance screens.
Integer	getMaxLength() The maxLength element determines the maximum size of the field for data entry edit purposes and for display purposes.
Integer	getMaxOccurs() The maximum number of allowed occurences of this field TODO: Get RICE to rename this getMaxOccurs so it matches the setter TODO: Get RICE to set a value that means UNBOUNDED, perhaps 999999999
Integer	getMinLength() The miniumum length allowed for the field.
Integer	getMinOccurs() The minimum number of allowed occurences TODO: get Rice to rename this to getMinOccurs to it matches the setter.
String	getName() The name of the attribute (or field).
String	getShortLabel() The shortLabel element is the field or collection name that will be used in applications when a shorter name (than the label element) is required.
String	getSummary() The summary element is used to provide a short description of the attribute or collection.
ValidCharactersConstraintInfo	getValidCharactersConstraint() The constraint that applies regular expressions to to the value TODO: Ask RICE to create an interface for ValidCharactersConstraint so we can return that instead of the generic constraint

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeDefinitionInfo

public AttributeDefinitionInfo()

Constructs a new AttributeDefinitionInfo.

AttributeDefinitionInfo

public AttributeDefinitionInfo(AttributeDefinitionInfc attrDef)

Constructs a new AttributeDefinitionInfo from an AttributeDefinition.

Parameters:

attrDef - the AttributeDefinition to copy

Method Detail

getName

public String getName()

Description copied from interface: AttributeDefinitionInfc

The name of the attribute (or field). Should match the field name on the corresponding business object. TODO: figure out how to handle sub-objects. I.e. using dot notation?

Specified by:

getName in interface AttributeDefinitionInfc

getChildEntryName

public String getChildEntryName()

Specified by:

getChildEntryName in interface AttributeDefinitionInfc

getDataType

public DataType getDataType()

Description copied from interface: AttributeDefinitionInfc

The type of data this attribite (field) holds. I.e. STRING, INTEGER, DATE, LONG, DATETIME, COMPLEX, etc.

Specified by:

getDataType in interface AttributeDefinitionInfc

getIsRequired

public Boolean getIsRequired()

Description copied from interface: AttributeDefinitionInfc

The required element allows values of "true" or "false". A value of "true" indicates that a value must be entered for this business object when creating or editing a new business object.

Specified by:

getIsRequired in interface AttributeDefinitionInfc

getMinOccurs

public Integer getMinOccurs()

Description copied from interface: AttributeDefinitionInfc

The minimum number of allowed occurences TODO: get Rice to rename this to getMinOccurs to it matches the setter.

Specified by:

getMinOccurs in interface AttributeDefinitionInfc

getMaxOccurs

public Integer getMaxOccurs()

Description copied from interface: AttributeDefinitionInfc

The maximum number of allowed occurences of this field TODO: Get RICE to rename this getMaxOccurs so it matches the setter TODO: Get RICE to set a value that means UNBOUNDED, perhaps 999999999

Specified by:

getMaxOccurs in interface AttributeDefinitionInfc

getMinLength

public Integer getMinLength()

Description copied from interface: AttributeDefinitionInfc

The miniumum length allowed for the field.

Specified by:

getMinLength in interface AttributeDefinitionInfc

getMaxLength

public Integer getMaxLength()

Description copied from interface: AttributeDefinitionInfc

The maxLength element determines the maximum size of the field for data entry edit purposes and for display purposes.

Specified by:

getMaxLength in interface AttributeDefinitionInfc

getIsForceUppercase

public Boolean getIsForceUppercase()

Description copied from interface: AttributeDefinitionInfc

Converts user entry to uppercase and always display database value as uppercase.

Specified by:

getIsForceUppercase in interface AttributeDefinitionInfc

getShortLabel

public String getShortLabel()

Description copied from interface: AttributeDefinitionInfc

The shortLabel element is the field or collection name that will be used in applications when a shorter name (than the label element) is required. This will be overridden by presence of displayLabelAttribute element.

Specified by:

getShortLabel in interface AttributeDefinitionInfc

getSummary

public String getSummary()

Description copied from interface: AttributeDefinitionInfc

The summary element is used to provide a short description of the attribute or collection. This is designed to be used for help purposes.

Specified by:

getSummary in interface AttributeDefinitionInfc

getLabel

public String getLabel()

Description copied from interface: AttributeDefinitionInfc

The label element is the field or collection name that will be shown on inquiry and maintenance screens. This will be overridden by presence of displayLabelAttribute element.

Specified by:

getLabel in interface AttributeDefinitionInfc

getDescription

public String getDescription()

Description copied from interface: AttributeDefinitionInfc

The description element is used to provide a long description of the attribute or collection. This is designed to be used for help purposes.

Specified by:

getDescription in interface AttributeDefinitionInfc

getExclusiveMin

public String getExclusiveMin()

Description copied from interface: AttributeDefinitionInfc

The exclusiveMin element determines the minimum allowable value for data entry editing purposes. Value can be an integer or decimal value such as -.001 or 99.

Specified by:

getExclusiveMin in interface AttributeDefinitionInfc

getInclusiveMax

public String getInclusiveMax()

Description copied from interface: AttributeDefinitionInfc

The inclusiveMax element determines the maximum allowable value for data entry editing purposes. Value can be an integer or decimal value such as -.001 or 99. JSTL: This field is mapped into the field named "exclusiveMax".

Specified by:

getInclusiveMax in interface AttributeDefinitionInfc

getDisplayLabelAttribute

public String getDisplayLabelAttribute()

Description copied from interface: AttributeDefinitionInfc

The displayLabelAttribute element is used to indicate that the label and short label should be obtained from another attribute. The label element and short label element defined for this attribute will be overridden. Instead, the label and short label values will be obtained by referencing the corresponding values from the attribute indicated by this element.

Specified by:

getDisplayLabelAttribute in interface AttributeDefinitionInfc

getIsUnique

public Boolean getIsUnique()

Description copied from interface: AttributeDefinitionInfc

Similar to a db column that is flagged as unique, the value is unique across all data objects of that type

Specified by:

getIsUnique in interface AttributeDefinitionInfc

getCustomValidatorClass

public String getCustomValidatorClass()

Description copied from interface: AttributeDefinitionInfc

Class to do custom validation

Specified by:

getCustomValidatorClass in interface AttributeDefinitionInfc

getFormatterClass

public String getFormatterClass()

Description copied from interface: AttributeDefinitionInfc

The formatterClass element is used when custom formatting is required for display of the field value. This field specifies the name of the java class to be used for the formatting. About 15 different classes are available including BooleanFormatter, CurrencyFormatter, DateFormatter, etc.

Specified by:

getFormatterClass in interface AttributeDefinitionInfc

getValidCharactersConstraint

public ValidCharactersConstraintInfo getValidCharactersConstraint()

Description copied from interface: AttributeDefinitionInfc

The constraint that applies regular expressions to to the value TODO: Ask RICE to create an interface for ValidCharactersConstraint so we can return that instead of the generic constraint

Specified by:

getValidCharactersConstraint in interface AttributeDefinitionInfc