|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase org.kuali.rice.krad.datadictionary.AttributeDefinitionBase org.kuali.rice.krad.datadictionary.AttributeDefinition
public class 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.
Field Summary | |
---|---|
protected String |
additionalDisplayAttributeName
|
protected String |
alternateDisplayAttributeName
|
protected AttributeSecurity |
attributeSecurity
|
protected CaseConstraint |
caseConstraint
|
protected String |
childEntryName
|
protected ControlDefinition |
control
|
protected Control |
controlField
|
protected String |
customValidatorClass
|
protected DataType |
dataType
|
protected List<PrerequisiteConstraint> |
dependencyConstraints
|
protected Boolean |
dynamic
|
protected String |
exclusiveMin
|
protected Boolean |
forceUppercase
|
protected String |
formatterClass
|
protected String |
inclusiveMax
|
protected String |
lookupContextPath
|
protected LookupConstraint |
lookupDefinition
|
protected Integer |
maxLength
|
protected Integer |
minLength
|
protected List<MustOccurConstraint> |
mustOccurConstraints
|
protected Boolean |
unique
|
protected ValidationPattern |
validationPattern
Deprecated. |
protected ValidCharactersConstraint |
validCharactersConstraint
|
Fields inherited from class org.kuali.rice.krad.datadictionary.AttributeDefinitionBase |
---|
constraint, description, displayLabelAttribute, label, messageKey, name, required, shortLabel, summary |
Fields inherited from class org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase |
---|
id |
Constructor Summary | |
---|---|
AttributeDefinition()
|
Method Summary | |
---|---|
void |
afterPropertiesSet()
This overridden method ... |
void |
completeValidation(Class<?> rootObjectClass,
Class<?> otherObjectClass)
Directly validate simple fields, call completeValidation on Definition fields. |
String |
getAdditionalDisplayAttributeName()
|
String |
getAlternateDisplayAttributeName()
|
AttributeSecurity |
getAttributeSecurity()
|
CaseConstraint |
getCaseConstraint()
|
String |
getChildEntryName()
|
String |
getConstraint()
|
ControlDefinition |
getControl()
|
Control |
getControlField()
Default Control to use when the attribute is to be rendered
for the UI. |
String |
getCustomValidatorClass()
|
DataType |
getDataType()
|
String |
getExclusiveMin()
|
Boolean |
getForceUppercase()
|
String |
getFormatterClass()
|
String |
getInclusiveMax()
The inclusiveMax element determines the maximum allowable value for data entry editing purposes. |
String |
getLookupContextPath()
|
LookupConstraint |
getLookupDefinition()
|
Integer |
getMaxLength()
|
Integer |
getMinLength()
|
List<MustOccurConstraint> |
getMustOccurConstraints()
|
KeyValuesFinder |
getOptionsFinder()
Instance of KeyValluesFinder that should be invoked to
provide a List of values the field can have. |
List<PrerequisiteConstraint> |
getPrerequisiteConstraints()
|
Boolean |
getUnique()
|
ValidationPattern |
getValidationPattern()
|
ValidCharactersConstraint |
getValidCharactersConstraint()
|
boolean |
hasAttributeSecurity()
|
boolean |
hasFormatterClass()
|
boolean |
hasValidationPattern()
|
void |
setAdditionalDisplayAttributeName(String additionalDisplayAttributeName)
|
void |
setAlternateDisplayAttributeName(String alternateDisplayAttributeName)
|
void |
setAttributeSecurity(AttributeSecurity attributeSecurity)
|
void |
setCaseConstraint(CaseConstraint caseConstraint)
|
void |
setChildEntryName(String childEntryName)
|
void |
setConstraint(String constraint)
|
void |
setControl(ControlDefinition control)
The control element defines the manner in which an attribute is displayed and the manner in which the attribute value is entered. |
void |
setControlField(Control controlField)
Setter for the default control |
void |
setCustomValidatorClass(String customValidatorClass)
|
void |
setDataType(DataType dataType)
|
void |
setDataType(String dataType)
|
void |
setExclusiveMin(String exclusiveMin)
The exclusiveMin element determines the minimum allowable value for data entry editing purposes. |
void |
setForceUppercase(Boolean forceUppercase)
forceUppercase = convert user entry to uppercase and always display database value as uppercase. |
void |
setFormatterClass(String formatterClass)
The formatterClass element is used when custom formatting is required for display of the field value. |
void |
setInclusiveMax(String inclusiveMax)
The inclusiveMax element determines the maximum allowable value for data entry editing purposes. |
void |
setLookupContextPath(String lookupContextPath)
|
void |
setLookupDefinition(LookupConstraint lookupDefinition)
|
void |
setMaxLength(Integer maxLength)
The maxLength element determines the maximum size of the field for data entry edit purposes and for display purposes. |
void |
setMinLength(Integer minLength)
|
void |
setMustOccurConstraints(List<MustOccurConstraint> mustOccurConstraints)
|
void |
setOptionsFinder(KeyValuesFinder optionsFinder)
Setter for the field's KeyValuesFinder instance |
void |
setOptionsFinderClass(Class<? extends KeyValuesFinder> optionsFinderClass)
Setter that takes in the class name for the options finder and creates a new instance to use as the finder for the attribute field |
void |
setPrerequisiteConstraints(List<PrerequisiteConstraint> dependencyConstraints)
|
void |
setUnique(Boolean unique)
|
void |
setValidationPattern(ValidationPattern validationPattern)
The validationPattern element defines the allowable character-level or field-level values for an attribute. |
void |
setValidCharactersConstraint(ValidCharactersConstraint validCharactersConstraint)
|
String |
toString()
|
Methods inherited from class org.kuali.rice.krad.datadictionary.AttributeDefinitionBase |
---|
getDescription, getDirectShortLabel, getDisplayLabelAttribute, getLabel, getName, getShortLabel, getSummary, isRequired, 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 |
Methods inherited from interface org.kuali.rice.krad.datadictionary.validation.capability.Constrainable |
---|
getName |
Field Detail |
---|
protected Boolean forceUppercase
protected DataType dataType
protected Integer minLength
protected Integer maxLength
protected Boolean unique
protected String exclusiveMin
protected String inclusiveMax
@Deprecated protected ValidationPattern validationPattern
protected ControlDefinition control
protected Control controlField
protected String formatterClass
protected AttributeSecurity attributeSecurity
protected Boolean dynamic
protected String customValidatorClass
protected ValidCharactersConstraint validCharactersConstraint
protected CaseConstraint caseConstraint
protected List<PrerequisiteConstraint> dependencyConstraints
protected List<MustOccurConstraint> mustOccurConstraints
protected LookupConstraint lookupDefinition
protected String lookupContextPath
protected String childEntryName
protected String alternateDisplayAttributeName
protected String additionalDisplayAttributeName
Constructor Detail |
---|
public AttributeDefinition()
Method Detail |
---|
public void setForceUppercase(Boolean forceUppercase)
public Boolean getForceUppercase()
public Integer getMaxLength()
getMaxLength
in interface LengthConstraint
public void setMaxLength(Integer maxLength)
public String getExclusiveMin()
getExclusiveMin
in interface RangeConstraint
public void setExclusiveMin(String exclusiveMin)
public String getInclusiveMax()
getInclusiveMax
in interface RangeConstraint
public void setInclusiveMax(String inclusiveMax)
public boolean hasValidationPattern()
public ValidationPattern getValidationPattern()
public void setValidationPattern(ValidationPattern validationPattern)
public ControlDefinition getControl()
public void setControl(ControlDefinition control)
control
-
IllegalArgumentException
- if the given control is nullpublic boolean hasFormatterClass()
public String getFormatterClass()
getFormatterClass
in interface Formatable
public void setFormatterClass(String formatterClass)
public void completeValidation(Class<?> rootObjectClass, Class<?> otherObjectClass)
completeValidation
in interface DataDictionaryDefinition
rootObjectClass
- Class of the BusinessObjectEntry which ultimately contains this definitionotherObjectClass
- other stuff required to complete validationDataDictionaryEntry.completeValidation()
public String toString()
toString
in class Object
Object.toString()
public AttributeSecurity getAttributeSecurity()
public void setAttributeSecurity(AttributeSecurity attributeSecurity)
attributeSecurity
- the attributeSecurity to setpublic boolean hasAttributeSecurity()
public void afterPropertiesSet() throws Exception
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
afterPropertiesSet
in class DataDictionaryDefinitionBase
Exception
InitializingBean.afterPropertiesSet()
public Boolean getUnique()
public void setUnique(Boolean unique)
unique
- the unique to setpublic Control getControlField()
Control
to use when the attribute is to be rendered
for the UI. Used by the UIF when a control is not defined for an
AttributeField
public void setControlField(Control controlField)
controlField
- public Integer getMinLength()
getMinLength
in interface LengthConstraint
public void setMinLength(Integer minLength)
minLength
- the minLength to setpublic DataType getDataType()
getDataType
in interface DataTypeConstraint
public void setDataType(DataType dataType)
dataType
- the dataType to setpublic void setDataType(String dataType)
public String getCustomValidatorClass()
public void setCustomValidatorClass(String customValidatorClass)
customValidatorClass
- the customValidatorClass to setpublic ValidCharactersConstraint getValidCharactersConstraint()
getValidCharactersConstraint
in interface ValidCharactersConstrainable
public void setValidCharactersConstraint(ValidCharactersConstraint validCharactersConstraint)
validCharactersConstraint
- the validChars to setpublic CaseConstraint getCaseConstraint()
getCaseConstraint
in interface CaseConstrainable
public void setCaseConstraint(CaseConstraint caseConstraint)
caseConstraint
- the caseConstraint to setpublic List<PrerequisiteConstraint> getPrerequisiteConstraints()
getPrerequisiteConstraints
in interface PrerequisiteConstrainable
public void setPrerequisiteConstraints(List<PrerequisiteConstraint> dependencyConstraints)
dependencyConstraints
- the requireConstraint to setpublic List<MustOccurConstraint> getMustOccurConstraints()
getMustOccurConstraints
in interface MustOccurConstrainable
public void setMustOccurConstraints(List<MustOccurConstraint> mustOccurConstraints)
mustOccurConstraints
- the occursConstraint to setpublic LookupConstraint getLookupDefinition()
public void setLookupDefinition(LookupConstraint lookupDefinition)
lookupDefinition
- the lookupDefinition to setpublic String getLookupContextPath()
public void setLookupContextPath(String lookupContextPath)
lookupContextPath
- the lookupContextPath to setpublic String getChildEntryName()
getChildEntryName
in interface HierarchicallyConstrainable
public void setChildEntryName(String childEntryName)
childEntryName
- the childEntryName to setpublic String getConstraint()
public void setConstraint(String constraint)
constraintMessage
- the constraintMessage to setpublic KeyValuesFinder getOptionsFinder()
KeyValluesFinder
that should be invoked to
provide a List of values the field can have. Generally used to provide
the options for a multi-value control or to validate the submitted field
value
public void setOptionsFinder(KeyValuesFinder optionsFinder)
optionsFinder
- public void setOptionsFinderClass(Class<? extends KeyValuesFinder> optionsFinderClass)
optionsFinderClass
- public void setAdditionalDisplayAttributeName(String additionalDisplayAttributeName)
public String getAdditionalDisplayAttributeName()
public void setAlternateDisplayAttributeName(String alternateDisplayAttributeName)
public String getAlternateDisplayAttributeName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |