Package org.kuali.rice.krad.datadictionary

Class DataObjectEntry

java.lang.Object
org.kuali.rice.krad.datadictionary.DictionaryBeanBase
org.kuali.rice.krad.datadictionary.DataDictionaryEntryBase
org.kuali.rice.krad.datadictionary.DataObjectEntry
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DataDictionaryEntry, DictionaryBean, Constrainable, MustOccurConstrainable
Direct Known Subclasses:
BusinessObjectEntry
public class DataObjectEntry extends DataDictionaryEntryBase implements MustOccurConstrainable
Generic dictionary entry for an object that does not have to implement BusinessObject. It provides support for general objects
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Field Details

    • name

      protected String name

    • dataObjectClass

      protected Class<?> dataObjectClass

    • baseDataObjectClass

      protected Class<?> baseDataObjectClass

    • titleAttribute

      protected String titleAttribute

    • objectLabel

      protected String objectLabel

    • objectDescription

      protected String objectDescription

    • primaryKeys

      protected List<String> primaryKeys

    • exporterClass

      protected Class<? extends org.kuali.rice.krad.bo.Exporter> exporterClass

    • mustOccurConstraints

      protected List<MustOccurConstraint> mustOccurConstraints

    • groupByAttributesForEffectiveDating

      protected List<String> groupByAttributesForEffectiveDating

    • helpDefinition

      protected HelpDefinition helpDefinition

    • boNotesEnabled

      protected boolean boNotesEnabled

    • inactivationBlockingDefinitions

      protected List<InactivationBlockingDefinition> inactivationBlockingDefinitions

  • Constructor Details

    • DataObjectEntry

      public DataObjectEntry()

  • Method Details

    • completeValidation

      public void completeValidation()
      Description copied from class: DataDictionaryEntryBase
      Directly validate simple fields, call completeValidation on Definition fields.
      Specified by:
      completeValidation in interface DataDictionaryEntry
      Overrides:
      completeValidation in class DataDictionaryEntryBase

    • completeValidation

      public void completeValidation(ValidationTrace tracer)
      Directly validate simple fields
      Specified by:
      completeValidation in interface DataDictionaryEntry
      Overrides:
      completeValidation in class DataDictionaryEntryBase
      Parameters:
      tracer - - Record of object's location
      See Also:

    • getJstlKey

      public String getJstlKey()
      Specified by:
      getJstlKey in interface DataDictionaryEntry
      Returns:
      String used as a globally-unique key for this entry's jstl-exported version
      See Also:

    • getFullClassName

      public String getFullClassName()
      Description copied from interface: DataDictionaryEntry
      Returns the full class name of the underlying object.
      Specified by:
      getFullClassName in interface DataDictionaryEntry
      See Also:

    • getEntryClass

      public Class<?> getEntryClass()
      Specified by:
      getEntryClass in class DataDictionaryEntryBase
      See Also:

    • getDataObjectClass

      public Class<?> getDataObjectClass()
      Returns:
      the dataObjectClass

    • setDataObjectClass

      public void setDataObjectClass(Class<?> dataObjectClass)
      Parameters:
      dataObjectClass - the dataObjectClass to set

    • setBaseDataObjectClass

      public void setBaseDataObjectClass(Class<?> baseDataObjectClass)
      The baseDataObjectClass is an optional parameter for specifying a base class for the dataObjectClass, allowing the data dictionary to index by the base class in addition to the current class.

    • getBaseDataObjectClass

      public Class<?> getBaseDataObjectClass()

    • getName

      public String getName()
      Specified by:
      getName in interface Constrainable
      Returns:
      the name

    • setName

      public void setName(String name)
      Parameters:
      name - the name to set

    • getObjectLabel

      public String getObjectLabel()
      Returns:
      Returns the objectLabel.

    • setObjectLabel

      public void setObjectLabel(String objectLabel)
      The objectLabel provides a short name of the business object for use on help screens.
      Parameters:
      objectLabel - The objectLabel to set.

    • getObjectDescription

      public String getObjectDescription()
      Returns:
      Returns the description.

    • setObjectDescription

      public void setObjectDescription(String objectDescription)
      The objectDescription provides a brief description of the business object for use on help screens.
      Parameters:
      objectDescription - The description to set

    • getHelpDefinition

      public HelpDefinition getHelpDefinition()
      Gets the helpDefinition attribute.
      Returns:
      Returns the helpDefinition.

    • setHelpDefinition

      public void setHelpDefinition(HelpDefinition helpDefinition)
      Sets the helpDefinition attribute value. The objectHelp element provides the keys to obtain a help description from the system parameters table. parameterNamespace the namespace of the parameter containing help information parameterName the name of the parameter containing help information parameterDetailType the detail type of the parameter containing help information
      Parameters:
      helpDefinition - The helpDefinition to set.

    • getMustOccurConstraints

      public List<MustOccurConstraint> getMustOccurConstraints()
      Specified by:
      getMustOccurConstraints in interface MustOccurConstrainable
      Returns:
      the mustOccurConstraints

    • setMustOccurConstraints

      public void setMustOccurConstraints(List<MustOccurConstraint> mustOccurConstraints)
      Parameters:
      mustOccurConstraints - the mustOccurConstraints to set

    • getTitleAttribute

      public String getTitleAttribute()
      Returns:
      the titleAttribute

    • setTitleAttribute

      public void setTitleAttribute(String titleAttribute)
      The titleAttribute element is the name of the attribute that will be used as an inquiry field when the lookup search results fields are displayed. For some business objects, there is no obvious field to serve as the inquiry field. in that case a special field may be required for inquiry purposes.

    • getPrimaryKeys

      public List<String> getPrimaryKeys()
      Returns:
      the primaryKeys

    • setPrimaryKeys

      public void setPrimaryKeys(List<String> primaryKeys)
      Parameters:
      primaryKeys - the primaryKeys to set

    • getExporterClass

      public Class<? extends org.kuali.rice.krad.bo.Exporter> getExporterClass()

    • setExporterClass

      public void setExporterClass(Class<? extends org.kuali.rice.krad.bo.Exporter> exporterClass)

    • getGroupByAttributesForEffectiveDating

      public List<String> getGroupByAttributesForEffectiveDating()
      Provides list of attributes that should be used for grouping when performing effective dating logic in the framework
      Returns:
      List<String> list of attributes to group by

    • setGroupByAttributesForEffectiveDating

      public void setGroupByAttributesForEffectiveDating(List<String> groupByAttributesForEffectiveDating)
      Setter for the list of attributes to group by

    • isBoNotesEnabled

      public boolean isBoNotesEnabled()
      Gets the boNotesEnabled flag for the Data object

      true indicates that notes and attachments will be permanently associated with the business object false indicates that notes and attachments are associated with the document used to create or edit the business object.

      Returns:
      the boNotesEnabled flag

    • setBoNotesEnabled

      public void setBoNotesEnabled(boolean boNotesEnabled)
      Setter for the boNotesEnabled flag

    • getInactivationBlockingDefinitions

      public List<InactivationBlockingDefinition> getInactivationBlockingDefinitions()
      Gets the inactivationBlockingDefinitions for the Data object
      Returns:
      the list of InactivationBlockingDefinition

    • setInactivationBlockingDefinitions

      public void setInactivationBlockingDefinitions(List<InactivationBlockingDefinition> inactivationBlockingDefinitions)
      Setter for the inactivationBlockingDefinitions