Package org.kuali.rice.krad.datadictionary

Class ReferenceDefinition

java.lang.Object
org.kuali.rice.krad.datadictionary.DictionaryBeanBase
org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase
org.kuali.rice.krad.datadictionary.ReferenceDefinition
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DataDictionaryDefinition, DictionaryBean
public class ReferenceDefinition extends DataDictionaryDefinitionBase
The reference element specifies the name of a reference object that is required to exist in order for the primary business object to be created or modified on a BO. DD: See ReferenceDefinition.java JSTL: references are Maps with the following keys: attributeName (String) activeIndicatorAttributeName (String) activeIndicatorReversed (boolean String) attributeToHighlightOnFail (String) displayFieldName (String)
See Also:

  • Field Details

    • attributeName

      protected String attributeName

    • attributeToHighlightOnFail

      protected String attributeToHighlightOnFail

    • displayFieldName

      protected String displayFieldName

    • collection

      protected String collection

    • collectionBusinessObjectClass

      protected Class<?> collectionBusinessObjectClass

    • businessObjectClass

      protected Class<?> businessObjectClass

  • Constructor Details

    • ReferenceDefinition

      public ReferenceDefinition()

  • Method Details

    • getAttributeName

      public String getAttributeName()
      Returns:
      attributeName

    • setAttributeName

      public void setAttributeName(String attributeName)
      attributeName is the name of a reference object that must exist and not be null. In the case of a collection, then this is the name of a reference object within the collection element.
      Throws:
      IllegalArgumentException - if the given attributeName is blank

    • getAttributeToHighlightOnFail

      public String getAttributeToHighlightOnFail()
      Gets the attributeToHighlightOnFail attribute.
      Returns:
      Returns the attributeToHighlightOnFail.

    • setAttributeToHighlightOnFail

      public void setAttributeToHighlightOnFail(String attributeToHighlightOnFail)
      attributeToHighlightOnFail is the name of the busines object attribute which will be highlighted when the default existence check fails.

    • getDisplayFieldName

      public String getDisplayFieldName()
      Gets the displayFieldName attribute.
      Returns:
      Returns the displayFieldName.

    • setDisplayFieldName

      public void setDisplayFieldName(String displayFieldName)
      displayFieldName is the name of the field to pull the label as it will appear in an error message. e.g. "chartOfAccountsCode".

    • isDisplayFieldNameSet

      public boolean isDisplayFieldNameSet()
      This method returns true if the displayFieldName is set, otherwise it returns false. Whether the displayFieldName is set is defined by whether it has any non-whitespace content in it.
      Returns:
      true if the display field name is set

    • getCollection

      public String getCollection()

    • setCollection

      public void setCollection(String collection)
      collection is the name of a collection that must exist

    • isCollectionReference

      public boolean isCollectionReference()

    • getCollectionBusinessObjectClass

      public Class<?> getCollectionBusinessObjectClass()

    • setCollectionBusinessObjectClass

      public void setCollectionBusinessObjectClass(Class<?> collectionBusinessObjectClass)
      Class that the specified collection represents. Does not need to be set. The DD Will set this attribute through introspection.

    • dataDictionaryPostProcessing

      public void dataDictionaryPostProcessing()
      Description copied from interface: DictionaryBean
      Perform any needed post-processing of the bean properties. This will be called starting at the parent data object entry or document entry class and recursed down though all other DictionaryBean objects contained within.
      Specified by:
      dataDictionaryPostProcessing in interface DictionaryBean
      Overrides:
      dataDictionaryPostProcessing in class DictionaryBeanBase

    • completeValidation

      public void completeValidation(Class<?> rootBusinessObjectClass, Class<?> otherBusinessObjectClass, ValidationTrace tracer)
      Description copied from class: DataDictionaryDefinitionBase
      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
      Overrides:
      completeValidation in class DataDictionaryDefinitionBase
      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

    • getBusinessObjectClass

      public Class<?> getBusinessObjectClass()

    • setBusinessObjectClass

      public void setBusinessObjectClass(Class<?> businessObjectClass)