org.kuali.rice.krad.datadictionary
Class SupportAttributeDefinition

java.lang.Object
  org.kuali.rice.krad.datadictionary.DictionaryBeanBase
      org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase
          org.kuali.rice.krad.datadictionary.PrimitiveAttributeDefinition
              org.kuali.rice.krad.datadictionary.SupportAttributeDefinition

All Implemented Interfaces:

Serializable, Cloneable, Copyable, DataDictionaryDefinition, DictionaryBean

public class SupportAttributeDefinition
extends PrimitiveAttributeDefinition

Support attributes define additional attributes that can be used to generate lookup field conversions and lookup parameters. Field conversions and lookup parameters are normally generated using foreign key relationships defined within OJB and the DD. Because Person objects are linked in a special way (i.e. they may come from an external data source and not from the DB, such as LDAP), it is often necessary to define extra fields that are related to each other, sort of like a supplemental foreign key. sourceName is the name of the POJO property of the business object targetName is the name of attribute that corresponds to the sourceName in the looked up BO identifier when true, only the field marked as an identifier will be passed in as a lookup parameter at most one supportAttribute for each relationship should be defined as identifier="true"

See Also:

Serialized Form

Field Summary

protected boolean

identifier

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

sourceName, targetName

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

SupportAttributeDefinition()

Method Summary

void	completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) Directly validate simple fields.
void	completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass, ValidationTrace tracer) Directly validate simple fields
boolean	isIdentifier()
void	setIdentifier(boolean identifier) identifier when true, only the field marked as an identifier will be passed in as a lookup parameter at most one supportAttribute for each relationship should be defined as identifier="true"
String	toString()

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

getSourceName, getTargetName, setSourceName, setTargetName

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

getId, hasEmbeddedDataObjectMetadata, setEmbeddedDataObjectMetadata, setGeneratedFromMetadata, setId, wasGeneratedFromMetadata

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

clone, copy, copyProperties, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, preventModification, 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.krad.datadictionary.DictionaryBean

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Field Detail

identifier

protected boolean identifier

Constructor Detail

SupportAttributeDefinition

public SupportAttributeDefinition()

Method Detail

isIdentifier

public boolean isIdentifier()

setIdentifier

public void setIdentifier(boolean identifier)

identifier when true, only the field marked as an identifier will be passed in as a lookup parameter at most one supportAttribute for each relationship should be defined as identifier="true"

completeValidation

public void completeValidation(Class rootBusinessObjectClass,
                               Class otherBusinessObjectClass)

Directly validate simple fields.

Specified by:

completeValidation in interface DataDictionaryDefinition

Overrides:

completeValidation in class PrimitiveAttributeDefinition

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)

completeValidation

public void completeValidation(Class rootBusinessObjectClass,
                               Class otherBusinessObjectClass,
                               ValidationTrace tracer)

Directly validate simple fields

Specified by:

completeValidation in interface DataDictionaryDefinition

Overrides:

completeValidation in class PrimitiveAttributeDefinition

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

See Also:

DataDictionaryEntry.completeValidation(org.kuali.rice.krad.datadictionary.validator.ValidationTrace)

toString

public String toString()

Overrides:

toString in class PrimitiveAttributeDefinition