org.kuali.rice.kns.datadictionary

Class MaintainableCollectionDefinition

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

org.kuali.rice.kns.datadictionary.MaintainableItemDefinition

org.kuali.rice.kns.datadictionary.MaintainableCollectionDefinition

All Implemented Interfaces:

Serializable, Cloneable, CollectionDefinitionI, Copyable, DataDictionaryDefinition, DictionaryBean

Deprecated.

Use collections inside of MaintenanceDocumentView.

@Deprecated
public class MaintainableCollectionDefinition
extends MaintainableItemDefinition
implements CollectionDefinitionI

The maintainableCollection element defines a set of data fields, nested collections, summaryFields and duplicateIdentificationsFields. JSTL: maintainableCollection is a Map which is accessed using a key of the name of the maintainableCollection. Each entry contains the following keys and values: **Key** **Value** collection true name name of collection dataObjectClass name of collection class name is the name of the collection dataObjectClass is the class name of the objects in the collection sourceClassName is the class name of the BO used in a lookup sourceAttributeName is the name of the attribute which returns the collection includeAddLine is true if the user is given the ability to add multiple lines. includeMultipleLookupLine whether to render a quickfinder icon for multiple value lookups on the collection. Defaults to true summaryTitle is the label of the summary attributeToHighlightOnDuplicateKey is the name of an attribute to highlight if two records in the collection are the same based on the duplicateIdentificationFields element.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	attributeToHighlightOnDuplicateKey Deprecated.
protected Class<? extends BusinessObject>	businessObjectClass Deprecated.
protected Map<String,MaintainableFieldDefinition>	duplicateIdentificationFieldMap Deprecated.
protected List<MaintainableFieldDefinition>	duplicateIdentificationFields Deprecated.
protected boolean	includeAddLine Deprecated.
protected boolean	includeMultipleLookupLine Deprecated.
protected Map<String,MaintainableCollectionDefinition>	maintainableCollectionMap Deprecated.
protected List<MaintainableCollectionDefinition>	maintainableCollections Deprecated.
protected Map<String,MaintainableFieldDefinition>	maintainableFieldMap Deprecated.
protected List<MaintainableFieldDefinition>	maintainableFields Deprecated.
protected Class<? extends BusinessObject>	sourceClassName Deprecated.
protected Map<String,MaintainableFieldDefinition>	summaryFieldMap Deprecated.
protected List<MaintainableFieldDefinition>	summaryFields Deprecated.
protected String	summaryTitle Deprecated.

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
MaintainableCollectionDefinition() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) Deprecated. Directly validate simple fields, call completeValidation on Definition fields.
boolean	dissallowDuplicateKey() Deprecated.
String	getAttributeToHighlightOnDuplicateKey() Deprecated.
Class<? extends BusinessObject>	getBusinessObjectClass() Deprecated.
List<? extends CollectionDefinitionI>	getCollections() Deprecated.
List<MaintainableFieldDefinition>	getDuplicateIdentificationFields() Deprecated.
List<? extends FieldDefinitionI>	getFields() Deprecated.
boolean	getIncludeAddLine() Deprecated.
List<MaintainableCollectionDefinition>	getMaintainableCollections() Deprecated.
List<MaintainableFieldDefinition>	getMaintainableFields() Deprecated.
Class<? extends BusinessObject>	getSourceClassName() Deprecated.
List<? extends FieldDefinitionI>	getSummaryFields() Deprecated.
String	getSummaryTitle() Deprecated.
boolean	hasSummaryField(String key) Deprecated.
boolean	isAlwaysAllowCollectionDeletion() Deprecated.
boolean	isIncludeMultipleLookupLine() Deprecated.
void	setAlwaysAllowCollectionDeletion(boolean alwaysAllowCollectionDeletion) Deprecated.
void	setAttributeToHighlightOnDuplicateKey(String attributeToHighlightOnDuplicate) Deprecated. attributeToHighlightOnDuplicateKey is the name of an attribute to highlight if two records in the collection are the same based on the duplicateIdentificationFields element.
void	setBusinessObjectClass(Class<? extends BusinessObject> businessObjectClass) Deprecated. The BusinessObject class used for each row of this collection.
void	setDuplicateIdentificationFields(List<MaintainableFieldDefinition> duplicateIdentificationFields) Deprecated. The duplicateIdentificationFields element is used to define a set of fields that will be used to determine if two records in the collection are duplicates.
void	setIncludeAddLine(boolean includeAddLine) Deprecated. Control whether an "add" line should be included at the top of this collection.
void	setIncludeMultipleLookupLine(boolean includeMultipleLookupLine) Deprecated. Set whether the multiple lookup line (and link) should appear above this collection.
void	setMaintainableCollections(List<MaintainableCollectionDefinition> maintainableCollections) Deprecated. The list of sub-collections to include in this collection.
void	setMaintainableFields(List<MaintainableFieldDefinition> maintainableFields) Deprecated. The list of fields to include in this collection.
void	setSourceClassName(Class<? extends BusinessObject> sourceClass) Deprecated. BusinessObject class which should be used for multiple value lookups for this collection.
void	setSummaryFields(List<MaintainableFieldDefinition> summaryFields) Deprecated. The summaryFields element defines a set of summaryField elements.
void	setSummaryTitle(String overrideSummaryName) Deprecated. summaryTitle is the label of the summary
String	toString() Deprecated.

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

getName, setName

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

completeValidation, getId, hasEmbeddedDataObjectMetadata, setEmbeddedDataObjectMetadata, setGeneratedFromMetadata, setId, wasGeneratedFromMetadata

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

clone, copy, dataDictionaryPostProcessing, 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.kns.datadictionary.CollectionDefinitionI

getName

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

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Field Detail

businessObjectClass

protected Class<? extends BusinessObject> businessObjectClass

Deprecated.

sourceClassName

protected Class<? extends BusinessObject> sourceClassName

Deprecated.

summaryTitle

protected String summaryTitle

Deprecated.

attributeToHighlightOnDuplicateKey

protected String attributeToHighlightOnDuplicateKey

Deprecated.

includeAddLine

protected boolean includeAddLine

Deprecated.

includeMultipleLookupLine

protected boolean includeMultipleLookupLine

Deprecated.

maintainableFieldMap

protected Map<String,MaintainableFieldDefinition> maintainableFieldMap

Deprecated.

maintainableCollectionMap

protected Map<String,MaintainableCollectionDefinition> maintainableCollectionMap

Deprecated.

summaryFieldMap

protected Map<String,MaintainableFieldDefinition> summaryFieldMap

Deprecated.

duplicateIdentificationFieldMap

protected Map<String,MaintainableFieldDefinition> duplicateIdentificationFieldMap

Deprecated.

maintainableFields

protected List<MaintainableFieldDefinition> maintainableFields

Deprecated.

maintainableCollections

protected List<MaintainableCollectionDefinition> maintainableCollections

Deprecated.

summaryFields

protected List<MaintainableFieldDefinition> summaryFields

Deprecated.

duplicateIdentificationFields

protected List<MaintainableFieldDefinition> duplicateIdentificationFields

Deprecated.

Constructor Detail

MaintainableCollectionDefinition

public MaintainableCollectionDefinition()

Deprecated.

Method Detail

getBusinessObjectClass

public Class<? extends BusinessObject> getBusinessObjectClass()

Deprecated.

Specified by:

getBusinessObjectClass in interface CollectionDefinitionI

Returns:

businessObjectClass

setBusinessObjectClass

public void setBusinessObjectClass(Class<? extends BusinessObject> businessObjectClass)

Deprecated.

The BusinessObject class used for each row of this collection.

getMaintainableFields

public List<MaintainableFieldDefinition> getMaintainableFields()

Deprecated.

Returns:

Collection of all lookupField MaintainableFieldDefinitions associated with this MaintainableCollectionDefinition, in the order in which they were added

getFields

public List<? extends FieldDefinitionI> getFields()

Deprecated.

Specified by:

getFields in interface CollectionDefinitionI

completeValidation

public void completeValidation(Class rootBusinessObjectClass,
                               Class otherBusinessObjectClass)

Deprecated.

Directly validate simple fields, call completeValidation on Definition fields.

Specified by:

completeValidation in interface DataDictionaryDefinition

Overrides:

completeValidation in class DataDictionaryDefinitionBase

Parameters:

rootBusinessObjectClass - Class of the BusinessObjectEntry which ultimately contains this definition

otherBusinessObjectClass - other stuff required to complete validation

See Also:

org.kuali.rice.krad.datadictionary.DataDictionaryDefinition#completeValidation(java.lang.Class, java.lang.Object)

toString

public String toString()

Deprecated.

Overrides:

toString in class MaintainableItemDefinition

See Also:

Object.toString()

getSourceClassName

public Class<? extends BusinessObject> getSourceClassName()

Deprecated.

setSourceClassName

public void setSourceClassName(Class<? extends BusinessObject> sourceClass)

Deprecated.

BusinessObject class which should be used for multiple value lookups for this collection.

getIncludeAddLine

public boolean getIncludeAddLine()

Deprecated.

Specified by:

getIncludeAddLine in interface CollectionDefinitionI

setIncludeAddLine

public void setIncludeAddLine(boolean includeAddLine)

Deprecated.

Control whether an "add" line should be included at the top of this collection.

getMaintainableCollections

public List<MaintainableCollectionDefinition> getMaintainableCollections()

Deprecated.

Returns:

Collection of all lookupField MaintainableCollectionDefinitions associated with this MaintainableCollectionDefinition, in the order in which they were added

getCollections

public List<? extends CollectionDefinitionI> getCollections()

Deprecated.

Specified by:

getCollections in interface CollectionDefinitionI

getSummaryFields

public List<? extends FieldDefinitionI> getSummaryFields()

Deprecated.

Specified by:

getSummaryFields in interface CollectionDefinitionI

Returns:

Collection of all SummaryFieldDefinitions associated with this SummaryFieldDefinition, in the order in which they were added

hasSummaryField

public boolean hasSummaryField(String key)

Deprecated.

Specified by:

hasSummaryField in interface CollectionDefinitionI

isIncludeMultipleLookupLine

public boolean isIncludeMultipleLookupLine()

Deprecated.

setIncludeMultipleLookupLine

public void setIncludeMultipleLookupLine(boolean includeMultipleLookupLine)

Deprecated.

Set whether the multiple lookup line (and link) should appear above this collection.

getSummaryTitle

public String getSummaryTitle()

Deprecated.

Specified by:

getSummaryTitle in interface CollectionDefinitionI

setSummaryTitle

public void setSummaryTitle(String overrideSummaryName)

Deprecated.

summaryTitle is the label of the summary

getAttributeToHighlightOnDuplicateKey

public String getAttributeToHighlightOnDuplicateKey()

Deprecated.

setAttributeToHighlightOnDuplicateKey

public void setAttributeToHighlightOnDuplicateKey(String attributeToHighlightOnDuplicate)

Deprecated.

attributeToHighlightOnDuplicateKey is the name of an attribute to highlight if two records in the collection are the same based on the duplicateIdentificationFields element.

dissallowDuplicateKey

public boolean dissallowDuplicateKey()

Deprecated.

getDuplicateIdentificationFields

public List<MaintainableFieldDefinition> getDuplicateIdentificationFields()

Deprecated.

setMaintainableFields

public void setMaintainableFields(List<MaintainableFieldDefinition> maintainableFields)

Deprecated.

The list of fields to include in this collection.

setMaintainableCollections

public void setMaintainableCollections(List<MaintainableCollectionDefinition> maintainableCollections)

Deprecated.

The list of sub-collections to include in this collection.

setSummaryFields

public void setSummaryFields(List<MaintainableFieldDefinition> summaryFields)

Deprecated.

The summaryFields element defines a set of summaryField elements.

setDuplicateIdentificationFields

public void setDuplicateIdentificationFields(List<MaintainableFieldDefinition> duplicateIdentificationFields)

Deprecated.

The duplicateIdentificationFields element is used to define a set of fields that will be used to determine if two records in the collection are duplicates.

isAlwaysAllowCollectionDeletion

public boolean isAlwaysAllowCollectionDeletion()

Deprecated.

Specified by:

isAlwaysAllowCollectionDeletion in interface CollectionDefinitionI

setAlwaysAllowCollectionDeletion

public void setAlwaysAllowCollectionDeletion(boolean alwaysAllowCollectionDeletion)

Deprecated.