AttributeDefinitionInfo

Name AttributeDefinitionInfo
Usage DataDictionaryService
DictionaryEntryInfo
Type Complex

Description

Dictionary data for Attributes (or fields) that exist on an object.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
name Name String 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?		     One No  
childEntryName Child Entry Name String ???     One No  
dataType Data Type String The type of data this attribite (field) holds.
I.e. STRING, INTEGER, DATE, LONG, DATETIME, COMPLEX, etc.		     One No  
isRequired Is Required Boolean 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.		     One No  
minOccurs Minimum Occurences Integer The minimum number of allowed occurences

TODO: get Rice to rename this to getMinOccurs to it matches the
setter.		     One No  
maxOccurs Maximum Occurrences Integer 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		     One No  
minLength Minimum Length Integer The miniumum length allowed for the field.     One No  
maxLength Maximum Length Integer The maxLength element determines the maximum size of the field
for data entry edit purposes and for display purposes.		     One No  
isForceUppercase Force Uppercase Boolean Converts user entry to uppercase and always display database
value as uppercase.		     One No  
shortLabel Short Label String 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.		     One No  
summary Summary String The summary element is used to provide a short description of
the attribute or collection. This is designed to be used for
help purposes.		     One No  
label Label String 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.		     One No  
description Description String The description element is used to provide a long description
of the attribute or collection. This is designed to be used for
help purposes.		     One No  
exclusiveMin Exclusive Minimum String 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.		     One No  
inclusiveMax Exclusive Maximum String 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".		     One No  
displayLabelAttribute Display Label Attribute String 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.		     One No  
isUnique Unique Boolean Similar to a db column that is flagged as unique, the value is
unique across all data objects of that type		     One No  
customValidatorClass Custom Validator Class String Class to do custom validation     One No  
formatterClass Formatter Class String 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.		     One No  
validCharactersConstraint Valid Characters Constraint ValidCharactersConstraintInfo 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		     One No