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,org.kuali.rice.krad.datadictionary.Copyable,org.kuali.rice.krad.datadictionary.DataDictionaryDefinition,org.kuali.rice.krad.datadictionary.DictionaryBean
@Deprecated
public class MaintainableCollectionDefinition
extends MaintainableItemDefinition
implements CollectionDefinitionI
Deprecated.
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected StringDeprecated.protected Class<? extends org.kuali.rice.krad.bo.BusinessObject> Deprecated.protected Map<String, MaintainableFieldDefinition> Deprecated.protected List<MaintainableFieldDefinition> Deprecated.protected booleanDeprecated.protected booleanDeprecated.protected Map<String, MaintainableCollectionDefinition> Deprecated.protected List<MaintainableCollectionDefinition> Deprecated.protected Map<String, MaintainableFieldDefinition> Deprecated.protected List<MaintainableFieldDefinition> Deprecated.protected Class<? extends org.kuali.rice.krad.bo.BusinessObject> Deprecated.protected Map<String, MaintainableFieldDefinition> Deprecated.protected List<MaintainableFieldDefinition> Deprecated.protected StringDeprecated.Fields inherited from class org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase
embeddedDataObjectMetadata, generatedFromMetadata, idFields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase
componentCode, namespaceCode -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidcompleteValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) Deprecated.Directly validate simple fields, call completeValidation on Definition fields.booleanDeprecated.Deprecated.Class<? extends org.kuali.rice.krad.bo.BusinessObject> Deprecated.List<? extends CollectionDefinitionI> Deprecated.Deprecated.List<? extends FieldDefinitionI> Deprecated.booleanDeprecated.Deprecated.Deprecated.Class<? extends org.kuali.rice.krad.bo.BusinessObject> Deprecated.List<? extends FieldDefinitionI> Deprecated.Deprecated.booleanhasSummaryField(String key) Deprecated.booleanDeprecated.booleanDeprecated.voidsetAlwaysAllowCollectionDeletion(boolean alwaysAllowCollectionDeletion) Deprecated.voidsetAttributeToHighlightOnDuplicateKey(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.voidsetBusinessObjectClass(Class<? extends org.kuali.rice.krad.bo.BusinessObject> businessObjectClass) Deprecated.The BusinessObject class used for each row of this collection.voidsetDuplicateIdentificationFields(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.voidsetIncludeAddLine(boolean includeAddLine) Deprecated.Control whether an "add" line should be included at the top of this collection.voidsetIncludeMultipleLookupLine(boolean includeMultipleLookupLine) Deprecated.Set whether the multiple lookup line (and link) should appear above this collection.voidsetMaintainableCollections(List<MaintainableCollectionDefinition> maintainableCollections) Deprecated.The list of sub-collections to include in this collection.voidsetMaintainableFields(List<MaintainableFieldDefinition> maintainableFields) Deprecated.The list of fields to include in this collection.voidsetSourceClassName(Class<? extends org.kuali.rice.krad.bo.BusinessObject> sourceClass) Deprecated.BusinessObject class which should be used for multiple value lookups for this collection.voidsetSummaryFields(List<MaintainableFieldDefinition> summaryFields) Deprecated.The summaryFields element defines a set of summaryField elements.voidsetSummaryTitle(String overrideSummaryName) Deprecated.summaryTitle is the label of the summarytoString()Deprecated.Methods inherited from class org.kuali.rice.kns.datadictionary.MaintainableItemDefinition
getName, setNameMethods inherited from class org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase
completeValidation, getId, hasEmbeddedDataObjectMetadata, setEmbeddedDataObjectMetadata, setGeneratedFromMetadata, setId, wasGeneratedFromMetadataMethods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase
clone, copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCodeMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.kuali.rice.kns.datadictionary.CollectionDefinitionI
getNameMethods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean
dataDictionaryPostProcessing, getComponentCode, getNamespaceCode
-
Field Details
-
businessObjectClass
Deprecated. -
sourceClassName
Deprecated. -
summaryTitle
Deprecated. -
attributeToHighlightOnDuplicateKey
Deprecated. -
includeAddLine
protected boolean includeAddLineDeprecated. -
includeMultipleLookupLine
protected boolean includeMultipleLookupLineDeprecated. -
maintainableFieldMap
Deprecated. -
maintainableCollectionMap
Deprecated. -
summaryFieldMap
Deprecated. -
duplicateIdentificationFieldMap
Deprecated. -
maintainableFields
Deprecated. -
maintainableCollections
Deprecated. -
summaryFields
Deprecated. -
duplicateIdentificationFields
Deprecated.
-
-
Constructor Details
-
MaintainableCollectionDefinition
public MaintainableCollectionDefinition()Deprecated.
-
-
Method Details
-
getBusinessObjectClass
Deprecated.- Specified by:
getBusinessObjectClassin interfaceCollectionDefinitionI- Returns:
- businessObjectClass
-
setBusinessObjectClass
public void setBusinessObjectClass(Class<? extends org.kuali.rice.krad.bo.BusinessObject> businessObjectClass) Deprecated.The BusinessObject class used for each row of this collection. -
getMaintainableFields
Deprecated.- Returns:
- Collection of all lookupField MaintainableFieldDefinitions associated with this MaintainableCollectionDefinition, in the order in which they were added
-
getFields
Deprecated.- Specified by:
getFieldsin interfaceCollectionDefinitionI
-
completeValidation
Deprecated.Directly validate simple fields, call completeValidation on Definition fields.- Specified by:
completeValidationin interfaceorg.kuali.rice.krad.datadictionary.DataDictionaryDefinition- Overrides:
completeValidationin classorg.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase- See Also:
-
toString
Deprecated.- Overrides:
toStringin classMaintainableItemDefinition- See Also:
-
getSourceClassName
Deprecated. -
setSourceClassName
Deprecated.BusinessObject class which should be used for multiple value lookups for this collection. -
getIncludeAddLine
public boolean getIncludeAddLine()Deprecated.- Specified by:
getIncludeAddLinein interfaceCollectionDefinitionI
-
setIncludeAddLine
public void setIncludeAddLine(boolean includeAddLine) Deprecated.Control whether an "add" line should be included at the top of this collection. -
getMaintainableCollections
Deprecated.- Returns:
- Collection of all lookupField MaintainableCollectionDefinitions associated with this MaintainableCollectionDefinition, in the order in which they were added
-
getCollections
Deprecated.- Specified by:
getCollectionsin interfaceCollectionDefinitionI
-
getSummaryFields
Deprecated.- Specified by:
getSummaryFieldsin interfaceCollectionDefinitionI- Returns:
- Collection of all SummaryFieldDefinitions associated with this SummaryFieldDefinition, in the order in which they were added
-
hasSummaryField
Deprecated.- Specified by:
hasSummaryFieldin interfaceCollectionDefinitionI
-
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
Deprecated.- Specified by:
getSummaryTitlein interfaceCollectionDefinitionI
-
setSummaryTitle
Deprecated.summaryTitle is the label of the summary -
getAttributeToHighlightOnDuplicateKey
Deprecated. -
setAttributeToHighlightOnDuplicateKey
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
Deprecated. -
setMaintainableFields
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
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:
isAlwaysAllowCollectionDeletionin interfaceCollectionDefinitionI
-
setAlwaysAllowCollectionDeletion
public void setAlwaysAllowCollectionDeletion(boolean alwaysAllowCollectionDeletion) Deprecated.
-
MaintenanceDocumentView.