org.kuali.rice.krad.datadictionary

Class ExternalizableAttributeDefinitionProxy

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

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, Cloneable, Copyable, DataDictionaryDefinition, DictionaryBean, CaseConstrainable, Constrainable, ExistenceConstrainable, Formatable, HierarchicallyConstrainable, MustOccurConstrainable, PrerequisiteConstrainable, SimpleConstrainable, ValidCharactersConstrainable, Constraint, ExistenceConstraint

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, cachedDerivedControl, caseConstraint, childEntryName, control, controlField, customValidatorClass, dependencyConstraints, dynamic, forceUppercase, formatterClass, mustOccurConstraints, propertyEditor, unique, validationPattern, validCharactersConstraint

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

constraintText, dataObjectAttribute, description, displayLabelAttribute, label, name, shortLabel, simpleConstraint, summary

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

embeddedDataObjectMetadata, generatedFromMetadata, id

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

componentCode, namespaceCode

Constructor Summary

Constructors

Constructor and Description
ExternalizableAttributeDefinitionProxy() Constructs an AttributeReferenceDefinition

Method Summary

Methods

Modifier and Type	Method and Description
void	completeValidation(Class rootObjectClass, Class otherObjectClass, ValidationTrace tracer) Directly validate simple fields, call completeValidation on Definition fields.
ControlDefinition	getControl()
String	getDescription() The description element is used to provide a long description of the attribute or collection.
String	getDisplayLabelAttribute()
Boolean	getForceUppercase() Indicates whether user entry should be converted to upper case
String	getFormatterClass()
String	getLabel() The label element is the field or collection name that will be shown on inquiry and maintenance screens.
Integer	getMaxLength() Returns the maximum length for this field, if set.
String	getName() Name of the attribute
String	getShortLabel()
String	getSourceAttributeName()
String	getSourceExternalizableBusinessObjectInterface()
String	getSummary() The summary element is used to provide a short description of the attribute or collection.
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() The required element allows values of "true" or "false".
void	setSourceAttributeName(String sourceAttributeName)
void	setSourceExternalizableBusinessObjectInterface(String sourceClassName)
String	toString()

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

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

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

getConstraintText, getDataObjectAttribute, getDirectShortLabel, getSimpleConstraint, setConstraintText, setDataObjectAttribute, setDescription, setDisplayLabelAttribute, setLabel, setName, setRequired, setShortLabel, setSimpleConstraint, setSummary

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

getId, hasEmbeddedDataObjectMetadata, setEmbeddedDataObjectMetadata, setGeneratedFromMetadata, setId, wasGeneratedFromMetadata

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

clone, copy, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

getComponentCode, getNamespaceCode

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.

If not set and embedded metadata is present, the ForceUppercase value will be read from the linked metadata.

Overrides:

getForceUppercase in class AttributeDefinition

Returns:

boolean true if force upper case is set

See Also:

AttributeDefinition.getForceUppercase()

getName

public String getName()

Description copied from class: AttributeDefinitionBase

Name of the attribute

Specified by:

getName in interface Constrainable

Overrides:

getName in class AttributeDefinitionBase

Returns:

the name

See Also:

AttributeDefinitionBase.getName()

getLabel

public String getLabel()

Description copied from class: AttributeDefinitionBase

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.

Overrides:

getLabel in class AttributeDefinitionBase

Returns:

the label

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 class: AttributeDefinition

Returns the maximum length for this field, if set. If not set, it attempts to pull from the embedded metadata, if any. z

Overrides:

getMaxLength in class AttributeDefinition

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()

Description copied from class: AttributeDefinitionBase

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:

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()

Description copied from class: AttributeDefinitionBase

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

Overrides:

getSummary in class AttributeDefinitionBase

Returns:

the summary

See Also:

AttributeDefinitionBase.getSummary()

getDescription

public String getDescription()

Description copied from class: AttributeDefinitionBase

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

Overrides:

getDescription in class AttributeDefinitionBase

Returns:

the description

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,
                      ValidationTrace tracer)

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

tracer - ValidationTrace class used to track what was being validated at the time of any problems discovered

See Also:

DataDictionaryEntry.completeValidation()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()