AttributeDefinitionInfo (KS R2 POC 0.0.1-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.kuali.student.datadictionary.dto
Class AttributeDefinitionInfo

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

All Implemented Interfaces:: Serializable, AttributeDefinitionInfc

public class AttributeDefinitionInfo
extends Object
implements AttributeDefinitionInfc, Serializable
extends Object
implements AttributeDefinitionInfc, Serializable

See Also:: Serialized Form

Nested Class Summary
`static class`	`AttributeDefinitionInfo.Builder`

Field Summary
`private String`	`childEntryName`
`private String`	`customValidatorClass`
`private org.kuali.rice.kns.datadictionary.validation.DataType`	`dataType`
`private String`	`description`
`private String`	`displayLabelAttribute`
`private String`	`exclusiveMin`
`private Boolean`	`forceUppercase`
`private String`	`formatterClass`
`private String`	`inclusiveMax`
`private String`	`label`
`private Integer`	`maxLength`
`private Integer`	`maxOccurs`
`private Integer`	`minLength`
`private Integer`	`minOccurs`
`private String`	`name`
`private Boolean`	`required`
`private static long`	`serialVersionUID`
`private String`	`shortLabel`
`private String`	`summary`
`private Boolean`	`unique`
`private ValidCharactersConstraintInfo`	`validCharactersConstraint`

Constructor Summary
	`AttributeDefinitionInfo()`
`private`	`AttributeDefinitionInfo(AttributeDefinitionInfc infc)`

Method Summary
`String`	`getChildEntryName()` Name: child entry name deprecated
`String`	`getCustomValidatorClass()` Name: Custom Validator Class Class to do custom validation
`org.kuali.rice.kns.datadictionary.validation.DataType`	`getDataType()` Name: Data Type The type of data this attribite (field) holds.
`String`	`getDescription()` Name: Description The description element is used to provide a long description of the attribute or collection.
`String`	`getDisplayLabelAttribute()` Name: Display Label Attribute The displayLabelAttribute element is used to indicate that the label and short label should be obtained from another attribute.
`String`	`getExclusiveMin()` Name: Exclusive Minimum The exclusiveMin element determines the minimum allowable value for data entry editing purposes.
`Boolean`	`getForceUppercase()` Name: Force Uppercase forceUppercase = convert user entry to uppercase and always display database value as uppercase.
`String`	`getFormatterClass()` Name: Formatter Class The formatterClass element is used when custom formatting is required for display of the field value.
`String`	`getInclusiveMax()` Name: Exclusive Maximum The inclusiveMax element determines the maximum allowable value for data entry editing purposes.
`String`	`getLabel()` Name: Label The label element is the field or collection name that will be shown on inquiry and maintenance screens.
`Integer`	`getMaxLength()` Name: Maximum Length The maxLength element determines the maximum size of the field for data entry edit purposes and for display purposes.
`Integer`	`getMaxOccurs()` Name: Maximum Occurrences 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()` Name: Minimum Length The miniumum length allowed for the field
`Integer`	`getMinOccurs()` Name: Minimum Occurences The minimum number of allowed occurences TODO: get Rice to rename this to getMinOccurs to it matches the setter.
`String`	`getName()` Name: Name The name of the attribute (or field).
`String`	`getShortLabel()` Name: Short Label 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()` Name: Summary The summary element is used to provide a short description of the attribute or collection.
`ValidCharactersConstraintInfo`	`getValidCharactersConstraint()` Name: Valid Characters Constraint 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
`Boolean`	`isRequired()` Name: Required The required element allows values of "true" or "false".
`Boolean`	`isUnique()` Name: Unique Similar to a db column that is flagged as unique, the value is unique across all data objects of that type TODO: ask if this should be isUnique instead of getUnique?

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:: Constant Field Values

name

private String name

childEntryName

private String childEntryName

dataType

private org.kuali.rice.kns.datadictionary.validation.DataType dataType

required

private Boolean required

minOccurs

private Integer minOccurs

maxOccurs

private Integer maxOccurs

minLength

private Integer minLength

maxLength

private Integer maxLength

forceUppercase

private Boolean forceUppercase

shortLabel

private String shortLabel

summary

private String summary

label

private String label

description

private String description

exclusiveMin

private String exclusiveMin

inclusiveMax

private String inclusiveMax

displayLabelAttribute

private String displayLabelAttribute

unique

private Boolean unique

customValidatorClass

private String customValidatorClass

formatterClass

private String formatterClass

validCharactersConstraint

private ValidCharactersConstraintInfo validCharactersConstraint

Constructor Detail

AttributeDefinitionInfo

public AttributeDefinitionInfo()

AttributeDefinitionInfo

private AttributeDefinitionInfo(AttributeDefinitionInfc infc)

Method Detail