org.kuali.rice.kns.datadictionary
Class BusinessObjectEntry

java.lang.Object
  org.kuali.rice.kns.datadictionary.DataDictionaryEntryBase
      org.kuali.rice.kns.datadictionary.BusinessObjectEntry

All Implemented Interfaces:

DataDictionaryEntry, org.springframework.beans.factory.InitializingBean

public class BusinessObjectEntry
extends DataDictionaryEntryBase

A single BusinessObject entry in the DataDictionary, which contains information relating to the display, validation, and general maintenance of a BusinessObject and its attributes. DD: See BusinessObjectEntry.java JSTL: each businessObject is exposed as a Map which is accessed using a key of the business object class name. This map contains enties with the following keys businessObjectClass (String) exporterClass (String) inquiry (Map, optional) lookup (Map, optional) attributes (Map) collections (Map, optional) relationships (Map, optional) objectLabel (String, optional) objectDescription (String, optional) See BusinessObjectEntryMapper.java Note: the use of extraButton in the tag is deprecated, and may be removed in future versions of the data dictionary. Note: the setters do copious amounts of validation, to facilitate generating errors during the parsing process.

Field Summary

protected Class<? extends org.kuali.rice.kns.bo.BusinessObject>	baseBusinessObjectClass
protected boolean	boNotesEnabled
protected Class<? extends org.kuali.rice.kns.bo.BusinessObject>	businessObjectClass
protected Class<? extends org.kuali.rice.kns.bo.Exporter>	exporterClass
protected List<String>	groupByAttributesForEffectiveDating
protected HelpDefinition	helpDefinition
protected List<InactivationBlockingDefinition>	inactivationBlockingDefinitions
protected InquiryDefinition	inquiryDefinition
protected LookupDefinition	lookupDefinition
protected String	objectDescription
protected String	objectLabel
protected List<String>	primaryKeys
protected String	titleAttribute

Fields inherited from class org.kuali.rice.kns.datadictionary.DataDictionaryEntryBase

attributeMap, attributes, collectionMap, collections, relationshipMap, relationships

Constructor Summary

BusinessObjectEntry()

Method Summary

void	afterPropertiesSet() This overridden method ...
void	completeValidation() Directly validate simple fields, call completeValidation on Definition fields.
Class<? extends org.kuali.rice.kns.bo.BusinessObject>	getBaseBusinessObjectClass()
Class<? extends org.kuali.rice.kns.bo.BusinessObject>	getBusinessObjectClass()
Class	getEntryClass()
Class<? extends org.kuali.rice.kns.bo.Exporter>	getExporterClass()
String	getFullClassName() Returns the full class name of the underlying object.
List<String>	getGroupByAttributesForEffectiveDating()
HelpDefinition	getHelpDefinition() Gets the helpDefinition attribute.
List<InactivationBlockingDefinition>	getInactivationBlockingDefinitions()
InquiryDefinition	getInquiryDefinition()
String	getJstlKey()
LookupDefinition	getLookupDefinition()
String	getObjectDescription()
String	getObjectLabel()
List<String>	getPrimaryKeys()
String	getTitleAttribute()
boolean	hasInquiryDefinition()
boolean	hasLookupDefinition()
boolean	isBoNotesEnabled()
void	setBaseBusinessObjectClass(Class<? extends org.kuali.rice.kns.bo.BusinessObject> baseBusinessObjectClass) The baseBusinessObjectClass is an optional parameter for specifying a superclass for the businessObjectClass, allowing the data dictionary to index by superclass in addition to the current class.
void	setBoNotesEnabled(boolean boNotesEnabled) boNotesEnabled = true or false 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.
void	setBusinessObjectClass(Class<? extends org.kuali.rice.kns.bo.BusinessObject> businessObjectClass)
void	setExporterClass(Class<? extends org.kuali.rice.kns.bo.Exporter> exporterClass)
void	setGroupByAttributesForEffectiveDating(List<String> groupByAttributesForEffectiveDating)
void	setHelpDefinition(HelpDefinition helpDefinition) Sets the helpDefinition attribute value.
void	setInactivationBlockingDefinitions(List<InactivationBlockingDefinition> inactivationBlockingDefinitions)
void	setInquiryDefinition(InquiryDefinition inquiryDefinition) The inquiry element is used to specify the fields that will be displayed on the inquiry screen for this business object and the order in which they will appear.
void	setLookupDefinition(LookupDefinition lookupDefinition) The lookup element is used to specify the rules for "looking up" a business object.
void	setObjectDescription(String objectDescription) The objectDescription provides a brief description of the business object for use on help screens.
void	setObjectLabel(String objectLabel) The objectLabel provides a short name of the business object for use on help screens.
void	setPrimaryKeys(List<String> primaryKeys)
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.
String	toString()

Methods inherited from class org.kuali.rice.kns.datadictionary.DataDictionaryEntryBase

getAttributeDefinition, getAttributeNames, getAttributes, getCollectionDefinition, getCollectionNames, getCollections, getRelationshipDefinition, getRelationshipNames, getRelationships, setAttributes, setCollections, setRelationships

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

businessObjectClass

protected Class<? extends org.kuali.rice.kns.bo.BusinessObject> businessObjectClass

baseBusinessObjectClass

protected Class<? extends org.kuali.rice.kns.bo.BusinessObject> baseBusinessObjectClass

exporterClass

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

boNotesEnabled

protected boolean boNotesEnabled

inquiryDefinition

protected InquiryDefinition inquiryDefinition

lookupDefinition

protected LookupDefinition lookupDefinition

helpDefinition

protected HelpDefinition helpDefinition

titleAttribute

protected String titleAttribute

objectLabel

protected String objectLabel

objectDescription

protected String objectDescription

inactivationBlockingDefinitions

protected List<InactivationBlockingDefinition> inactivationBlockingDefinitions

primaryKeys

protected List<String> primaryKeys

groupByAttributesForEffectiveDating

protected List<String> groupByAttributesForEffectiveDating

Constructor Detail

BusinessObjectEntry

public BusinessObjectEntry()

Method Detail

getJstlKey

public String getJstlKey()

Returns:

String used as a globally-unique key for this entry's jstl-exported version

See Also:

DataDictionaryEntry.getJstlKey()

setBusinessObjectClass

public void setBusinessObjectClass(Class<? extends org.kuali.rice.kns.bo.BusinessObject> businessObjectClass)

getBusinessObjectClass

public Class<? extends org.kuali.rice.kns.bo.BusinessObject> getBusinessObjectClass()

setBaseBusinessObjectClass

public void setBaseBusinessObjectClass(Class<? extends org.kuali.rice.kns.bo.BusinessObject> baseBusinessObjectClass)

The baseBusinessObjectClass is an optional parameter for specifying a superclass for the businessObjectClass, allowing the data dictionary to index by superclass in addition to the current class.

getBaseBusinessObjectClass

public Class<? extends org.kuali.rice.kns.bo.BusinessObject> getBaseBusinessObjectClass()

getExporterClass

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

setExporterClass

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

isBoNotesEnabled

public boolean isBoNotesEnabled()

setBoNotesEnabled

public void setBoNotesEnabled(boolean boNotesEnabled)

boNotesEnabled = true or false 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.

hasInquiryDefinition

public boolean hasInquiryDefinition()

Returns:

true if this instance has an inquiryDefinition

getInquiryDefinition

public InquiryDefinition getInquiryDefinition()

Returns:

current inquiryDefinition for this BusinessObjectEntry, or null if there is none

setInquiryDefinition

public void setInquiryDefinition(InquiryDefinition inquiryDefinition)

The inquiry element is used to specify the fields that will be displayed on the inquiry screen for this business object and the order in which they will appear. DD: See InquiryDefinition.java JSTL: The inquiry element is a Map which is accessed using a key of "inquiry". This map contains the following keys: title (String) inquiryFields (Map) See InquiryMapBuilder.java

hasLookupDefinition

public boolean hasLookupDefinition()

Returns:

true if this instance has a lookupDefinition

getLookupDefinition

public LookupDefinition getLookupDefinition()

Returns:

current lookupDefinition for this BusinessObjectEntry, or null if there is none

setLookupDefinition

public void setLookupDefinition(LookupDefinition lookupDefinition)

The lookup element is used to specify the rules for "looking up" a business object. These specifications define the following: How to specify the search criteria used to locate a set of business objects How to display the search results DD: See LookupDefinition.java JSTL: The lookup element is a Map which is accessed using a key of "lookup". This map contains the following keys: lookupableID (String, optional) title (String) menubar (String, optional) defaultSort (Map, optional) lookupFields (Map) resultFields (Map) resultSetLimit (String, optional) See LookupMapBuilder.java

getTitleAttribute

public String getTitleAttribute()

Returns:

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.

completeValidation

public void completeValidation()

Directly validate simple fields, call completeValidation on Definition fields.

Specified by:

completeValidation in interface DataDictionaryEntry

Overrides:

completeValidation in class DataDictionaryEntryBase

getEntryClass

public Class getEntryClass()

Specified by:

getEntryClass in class DataDictionaryEntryBase

See Also:

DataDictionaryEntryBase.getEntryClass()

getFullClassName

public String getFullClassName()

Description copied from interface: DataDictionaryEntry

Returns the full class name of the underlying object.

See Also:

DataDictionaryEntry.getFullClassName()

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:

description - 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.

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

getInactivationBlockingDefinitions

public List<InactivationBlockingDefinition> getInactivationBlockingDefinitions()

setInactivationBlockingDefinitions

public void setInactivationBlockingDefinitions(List<InactivationBlockingDefinition> inactivationBlockingDefinitions)

getPrimaryKeys

public List<String> getPrimaryKeys()

Returns:

the primaryKeys

setPrimaryKeys

public void setPrimaryKeys(List<String> primaryKeys)

Parameters:

primaryKeys - the primaryKeys to set

getGroupByAttributesForEffectiveDating

public List<String> getGroupByAttributesForEffectiveDating()

setGroupByAttributesForEffectiveDating

public void setGroupByAttributesForEffectiveDating(List<String> groupByAttributesForEffectiveDating)

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Description copied from class: DataDictionaryEntryBase

This overridden method ...

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Overrides:

afterPropertiesSet in class DataDictionaryEntryBase

Throws:

Exception

See Also:

DataDictionaryEntryBase.afterPropertiesSet()