org.kuali.rice.krad.datadictionary

Class DataDictionaryDefinitionBase

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

All Implemented Interfaces:

Serializable, Cloneable, Copyable, DataDictionaryDefinition, DictionaryBean

Direct Known Subclasses:

AttributeDefinitionBase, CollectionDefinition, ControlDefinitionBase, DocumentCollectionPath, DocumentValuePathGroup, FieldDefinition, HeaderNavigation, HelpDefinition, InactivationBlockingDefinition, InquiryDefinition, InquirySectionDefinition, LookupDefinition, MaintainableItemDefinition, MaintainableSectionDefinition, PrimitiveAttributeDefinition, ReferenceDefinition, RelationshipDefinition, RoutingTypeDefinition, SearchingTypeDefinition, SortDefinition

public abstract class DataDictionaryDefinitionBase
extends DictionaryBeanBase
implements DataDictionaryDefinition

Common base class for DataDictionaryDefinition types.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	embeddedDataObjectMetadata
protected boolean	generatedFromMetadata
protected String	id

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

componentCode, namespaceCode

Constructor Summary

Constructors

Constructor and Description
DataDictionaryDefinitionBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	completeValidation(Class<?> rootBusinessObjectClass, Class<?> otherBusinessObjectClass) Deprecated.
void	completeValidation(Class<?> rootBusinessObjectClass, Class<?> otherBusinessObjectClass, ValidationTrace tracer) Empty implementation so that all subclasses do not need to implement this method if they have no local validation to perform.
String	getId()
boolean	hasEmbeddedDataObjectMetadata() Returns true if the given object contains an embedded KRAD Data metadata object which may be used for defaulting certain attributes.
void	setEmbeddedDataObjectMetadata(boolean embeddedDataObjectMetadata)
void	setGeneratedFromMetadata(boolean generatedFromMetadata)
void	setId(String id) A unique identifier for this data dictionary element.
boolean	wasGeneratedFromMetadata() Returns true if this data dictionary object was completely generated from KRAD Data metadata.

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, toString, wait, wait, wait

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

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Field Detail

id

protected String id

embeddedDataObjectMetadata

protected boolean embeddedDataObjectMetadata

generatedFromMetadata

protected boolean generatedFromMetadata

Constructor Detail

DataDictionaryDefinitionBase

public DataDictionaryDefinitionBase()

Method Detail

getId

public String getId()

Specified by:

getId in interface DataDictionaryDefinition

setId

public void setId(String id)

A unique identifier for this data dictionary element.

hasEmbeddedDataObjectMetadata

public boolean hasEmbeddedDataObjectMetadata()

Returns true if the given object contains an embedded KRAD Data metadata object which may be used for defaulting certain attributes.

wasGeneratedFromMetadata

public boolean wasGeneratedFromMetadata()

Returns true if this data dictionary object was completely generated from KRAD Data metadata.

setEmbeddedDataObjectMetadata

public void setEmbeddedDataObjectMetadata(boolean embeddedDataObjectMetadata)

setGeneratedFromMetadata

public void setGeneratedFromMetadata(boolean generatedFromMetadata)

completeValidation

@Deprecated
public void completeValidation(Class<?> rootBusinessObjectClass,
                                 Class<?> otherBusinessObjectClass)

Deprecated.

Default implementation so that all subclasses do not need to implement this deprecated method.

Specified by:

completeValidation in interface DataDictionaryDefinition

Parameters:

rootBusinessObjectClass - Class of the BusinessObjectEntry which ultimately contains this definition

otherBusinessObjectClass - other stuff required to complete validation

completeValidation

public void completeValidation(Class<?> rootBusinessObjectClass,
                      Class<?> otherBusinessObjectClass,
                      ValidationTrace tracer)

Empty implementation so that all subclasses do not need to implement this method if they have no local validation to perform.

Specified by:

completeValidation in interface DataDictionaryDefinition

Parameters:

rootBusinessObjectClass - Class of the BusinessObjectEntry which ultimately contains this definition

otherBusinessObjectClass - other stuff required to complete validation

tracer - ValidationTrace class used to track what was being validated at the time of any problems discovered