org.kuali.rice.krad.datadictionary
Class ExternalizableAttributeDefinitionProxy

java.lang.Object
  org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase
      org.kuali.rice.krad.datadictionary.AttributeDefinitionBase
          org.kuali.rice.krad.datadictionary.AttributeDefinition
              org.kuali.rice.krad.datadictionary.ExternalizableAttributeDefinitionProxy

All Implemented Interfaces:

Serializable, DataDictionaryDefinition, CaseConstrainable, Constrainable, ExistenceConstrainable, Formatable, HierarchicallyConstrainable, LengthConstrainable, MustOccurConstrainable, PrerequisiteConstrainable, RangeConstrainable, ValidCharactersConstrainable, Constraint, DataTypeConstraint, ExistenceConstraint, LengthConstraint, RangeConstraint, org.springframework.beans.factory.InitializingBean

public class ExternalizableAttributeDefinitionProxy
extends AttributeDefinition

A single attribute definition in the DataDictionary, which contains information relating to the display, validation, and general maintenance of a specific attribute of an entry.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.krad.datadictionary.AttributeDefinition

additionalDisplayAttributeName, alternateDisplayAttributeName, attributeSecurity, caseConstraint, childEntryName, control, controlField, customValidatorClass, dataType, dependencyConstraints, dynamic, exclusiveMin, forceUppercase, formatterClass, inclusiveMax, lookupContextPath, lookupDefinition, maxLength, minLength, mustOccurConstraints, propertyEditor, unique, validationPattern, validCharactersConstraint

Fields inherited from class org.kuali.rice.krad.datadictionary.AttributeDefinitionBase

constraintText, description, displayLabelAttribute, label, messageKey, name, required, shortLabel, summary

Fields inherited from class org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

id

Constructor Summary

ExternalizableAttributeDefinitionProxy()
Constructs an AttributeReferenceDefinition

Method Summary

void	completeValidation(Class rootObjectClass, Class otherObjectClass) Directly validate simple fields, call completeValidation on Definition fields.
ControlDefinition	getControl()
String	getDescription()
String	getDisplayLabelAttribute()
Boolean	getForceUppercase() Indicates whether user entry should be converted to upper case
String	getFormatterClass()
String	getLabel()
Integer	getMaxLength() Determines the maximum size of the field
String	getName()
String	getShortLabel()
String	getSourceAttributeName()
String	getSourceExternalizableBusinessObjectInterface()
String	getSummary()
ValidationPattern	getValidationPattern() Defines the allowable character-level or field-level values for an attribute
boolean	hasFormatterClass()
boolean	hasValidationPattern() Indicates whether a validation pattern has been set
Boolean	isRequired()
void	setSourceAttributeName(String sourceAttributeName)
void	setSourceExternalizableBusinessObjectInterface(String sourceClassName)
String	toString()

Methods inherited from class org.kuali.rice.krad.datadictionary.AttributeDefinition

afterPropertiesSet, getAdditionalDisplayAttributeName, getAlternateDisplayAttributeName, getAttributeSecurity, getCaseConstraint, getChildEntryName, getControlField, getCustomValidatorClass, getDataType, getExclusiveMin, getInclusiveMax, getLookupContextPath, getLookupDefinition, getMinLength, getMustOccurConstraints, getOptionsFinder, getPrerequisiteConstraints, getPropertyEditor, getUnique, getValidCharactersConstraint, hasAttributeSecurity, setAdditionalDisplayAttributeName, setAlternateDisplayAttributeName, setAttributeSecurity, setCaseConstraint, setChildEntryName, setControl, setControlField, setCustomValidatorClass, setDataType, setDataType, setExclusiveMin, setForceUppercase, setFormatterClass, setInclusiveMax, setLookupContextPath, setLookupDefinition, setMaxLength, setMinLength, setMustOccurConstraints, setOptionsFinder, setOptionsFinderClass, setPrerequisiteConstraints, setPropertyEditor, setPropertyEditorClass, setUnique, setValidationPattern, setValidCharactersConstraint

Methods inherited from class org.kuali.rice.krad.datadictionary.AttributeDefinitionBase

getConstraintText, getDirectShortLabel, setConstraintText, setDescription, setDisplayLabelAttribute, setLabel, setName, setRequired, setShortLabel, setSummary

Methods inherited from class org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

getId, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalizableAttributeDefinitionProxy

public ExternalizableAttributeDefinitionProxy()

Constructs an AttributeReferenceDefinition

Method Detail

setSourceExternalizableBusinessObjectInterface

public void setSourceExternalizableBusinessObjectInterface(String sourceClassName)

getSourceExternalizableBusinessObjectInterface

public String getSourceExternalizableBusinessObjectInterface()

setSourceAttributeName

public void setSourceAttributeName(String sourceAttributeName)

getSourceAttributeName

public String getSourceAttributeName()

getForceUppercase

public Boolean getForceUppercase()

Description copied from class: AttributeDefinition

Indicates whether user entry should be converted to upper case

If set all user input will be changed to uppercase. Values from the database will also be forced to display as upper case and thus be persisted as upper case.

Overrides:

getForceUppercase in class AttributeDefinition

Returns:

boolean true if force upper case is set

See Also:

AttributeDefinition.getForceUppercase()

getName

public String getName()

Specified by:

getName in interface Constrainable

Overrides:

getName in class AttributeDefinitionBase

See Also:

AttributeDefinitionBase.getName()

getLabel

public String getLabel()

Overrides:

getLabel in class AttributeDefinitionBase

See Also:

AttributeDefinitionBase.getLabel()

getShortLabel

public String getShortLabel()

Overrides:

getShortLabel in class AttributeDefinitionBase

Returns:

the shortLabel, or the label if no shortLabel has been set

See Also:

AttributeDefinitionBase.getShortLabel()

getMaxLength

public Integer getMaxLength()

Description copied from interface: LengthConstraint

Determines the maximum size of the field

The maximum size is used for data entry, data edit and display purposes.

Specified by:

getMaxLength in interface LengthConstraint

Overrides:

getMaxLength in class AttributeDefinition

Returns:

Integer specifying maximum length of field

See Also:

AttributeDefinition.getMaxLength()

hasValidationPattern

public boolean hasValidationPattern()

Description copied from class: AttributeDefinition

Indicates whether a validation pattern has been set

Overrides:

hasValidationPattern in class AttributeDefinition

Returns:

boolean

See Also:

AttributeDefinition.hasValidationPattern()

getValidationPattern

public ValidationPattern getValidationPattern()

Description copied from class: AttributeDefinition

Defines the allowable character-level or field-level values for an attribute

ValidationPattern is a Map which is accessed using a key of "validationPattern". Each entry may contain some of the keys listed below. The keys that may be present for a given attribute are dependent upon the type of validationPattern. maxLength (String) exactLength type allowWhitespace allowUnderscore allowPeriod validChars precision scale allowNegative The allowable keys (in addition to type) for each type are: Type**** ***Keys*** alphanumeric exactLength maxLength allowWhitespace allowUnderscore allowPeriod alpha exactLength maxLength allowWhitespace anyCharacter exactLength maxLength allowWhitespace charset validChars numeric exactLength maxLength fixedPoint allowNegative precision scale floatingPoint allowNegative date n/a emailAddress n/a javaClass n/a month n/a phoneNumber n/a timestamp n/a year n/a zipcode n/a Note: maxLength and exactLength are mutually exclusive. If one is entered, the other may not be entered. Note: See ApplicationResources.properties for exact regex patterns. e.g. validationPatternRegex.date for regex used in date validation.

Overrides:

getValidationPattern in class AttributeDefinition

Returns:

ValidationPattern

See Also:

AttributeDefinition.getValidationPattern()

isRequired

public Boolean isRequired()

Specified by:

isRequired in interface ExistenceConstraint

Overrides:

isRequired in class AttributeDefinitionBase

See Also:

AttributeDefinitionBase.isRequired()

getControl

public ControlDefinition getControl()

Overrides:

getControl in class AttributeDefinition

Returns:

control

See Also:

AttributeDefinition.getControl()

getSummary

public String getSummary()

Overrides:

getSummary in class AttributeDefinitionBase

See Also:

AttributeDefinitionBase.getSummary()

getDescription

public String getDescription()

Overrides:

getDescription in class AttributeDefinitionBase

See Also:

AttributeDefinitionBase.getDescription()

hasFormatterClass

public boolean hasFormatterClass()

Overrides:

hasFormatterClass in class AttributeDefinition

See Also:

AttributeDefinition.hasFormatterClass()

getFormatterClass

public String getFormatterClass()

Specified by:

getFormatterClass in interface Formatable

Overrides:

getFormatterClass in class AttributeDefinition

See Also:

AttributeDefinition.getFormatterClass()

getDisplayLabelAttribute

public String getDisplayLabelAttribute()

Overrides:

getDisplayLabelAttribute in class AttributeDefinitionBase

See Also:

AttributeDefinitionBase.getDisplayLabelAttribute()

completeValidation

public void completeValidation(Class rootObjectClass,
                               Class otherObjectClass)

Description copied from class: AttributeDefinition

Directly validate simple fields, call completeValidation on Definition fields.

Specified by:

completeValidation in interface DataDictionaryDefinition

Overrides:

completeValidation in class AttributeDefinition

Parameters:

rootObjectClass - Class of the BusinessObjectEntry which ultimately contains this definition

otherObjectClass - other stuff required to complete validation

See Also:

DataDictionaryEntry.completeValidation()

toString

public String toString()

Overrides:

toString in class AttributeDefinition

See Also:

Object.toString()