org.kuali.rice.kns.datadictionary
Class CollectionDefinition

java.lang.Object
  org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase
      org.kuali.rice.kns.datadictionary.CollectionDefinition

All Implemented Interfaces:

Serializable, DataDictionaryDefinition, CollectionSizeConstrainable, Constrainable, CollectionSizeConstraint, Constraint, org.springframework.beans.factory.InitializingBean

public class CollectionDefinition
extends DataDictionaryDefinitionBase
implements CollectionSizeConstrainable

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

See Also:

Serialized Form

Field Summary

protected String	dataObjectClass
protected String	description
protected String	elementLabel
protected String	label
protected Integer	maxOccurs
protected Integer	minOccurs
protected String	name
protected String	shortLabel
protected String	summary

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

id

Constructor Summary

CollectionDefinition()

Method Summary

void	completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) Directly validate simple fields, call completeValidation on Definition fields.
String	getDataObjectClass()
String	getDescription()
String	getElementLabel() Gets the elementLabel attribute.
String	getLabel()
Integer	getMaximumNumberOfElements()
Integer	getMaxOccurs()
Integer	getMinimumNumberOfElements()
Integer	getMinOccurs()
String	getName()
String	getShortLabel()
String	getSummary()
void	setDataObjectClass(String dataObjectClass)
void	setDescription(String description) The description element is used to provide a long description of the attribute or collection.
void	setElementLabel(String elementLabel) The elementLabel defines the name to be used for a single object within the collection.
void	setLabel(String label)
void	setMaxOccurs(Integer maxOccurs)
void	setMinOccurs(Integer minOccurs)
void	setName(String name)
void	setShortLabel(String shortLabel)
void	setSummary(String summary) The summary element is used to provide a short description of the attribute or collection.
String	toString()

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

afterPropertiesSet, getId, setId

Methods inherited from class java.lang.Object

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

Field Detail

dataObjectClass

protected String dataObjectClass

name

protected String name

label

protected String label

shortLabel

protected String shortLabel

elementLabel

protected String elementLabel

summary

protected String summary

description

protected String description

minOccurs

protected Integer minOccurs

maxOccurs

protected Integer maxOccurs

Constructor Detail

CollectionDefinition

public CollectionDefinition()

Method Detail

getName

public String getName()

Specified by:

getName in interface Constrainable

setName

public void setName(String name)

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

getShortLabel

public String getShortLabel()

Returns:

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

setShortLabel

public void setShortLabel(String shortLabel)

getElementLabel

public String getElementLabel()

Gets the elementLabel attribute.

Returns:

Returns the elementLabel.

setElementLabel

public void setElementLabel(String elementLabel)

The elementLabel defines the name to be used for a single object within the collection. For example: "Address" may be the name of one object within the "Addresses" collection.

getSummary

public String getSummary()

setSummary

public void setSummary(String summary)

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

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

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

getDataObjectClass

public String getDataObjectClass()

Returns:

the objectClass

setDataObjectClass

public void setDataObjectClass(String dataObjectClass)

Parameters:

objectClass - the objectClass to set

completeValidation

public void completeValidation(Class rootBusinessObjectClass,
                               Class otherBusinessObjectClass)

Directly validate simple fields, call completeValidation on Definition fields.

Specified by:

completeValidation in interface DataDictionaryDefinition

Parameters:

rootBusinessObjectClass - Class of the BusinessObjectEntry which ultimately contains this definition

otherBusinessObjectClass - other stuff required to complete validation

See Also:

DataDictionaryEntry.completeValidation()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

getMaximumNumberOfElements

public Integer getMaximumNumberOfElements()

Specified by:

getMaximumNumberOfElements in interface CollectionSizeConstraint

See Also:

CollectionSizeConstraint.getMaximumNumberOfElements()

getMinimumNumberOfElements

public Integer getMinimumNumberOfElements()

Specified by:

getMinimumNumberOfElements in interface CollectionSizeConstraint

See Also:

CollectionSizeConstraint.getMinimumNumberOfElements()

getMinOccurs

public Integer getMinOccurs()

Returns:

the minOccurs

setMinOccurs

public void setMinOccurs(Integer minOccurs)

Parameters:

minOccurs - the minOccurs to set

getMaxOccurs

public Integer getMaxOccurs()

Returns:

the maxOccurs

setMaxOccurs

public void setMaxOccurs(Integer maxOccurs)

Parameters:

maxOccurs - the maxOccurs to set