org.kuali.rice.kns.datadictionary
Class MaintainableSectionDefinition

java.lang.Object
  org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase
      org.kuali.rice.kns.datadictionary.MaintainableSectionDefinition

All Implemented Interfaces:

Serializable, DataDictionaryDefinition, org.springframework.beans.factory.InitializingBean

public class MaintainableSectionDefinition
extends DataDictionaryDefinitionBase

The maintainableSection element defines one section of the maintenance document. JSTL: maintainableSection is a Map which is accessed by an integer representing the sequential occurrence of the section. e.g. "0", "1", etc. This map contains entries with the following keys: index (String) - e.g. "0" for first section, etc. title (String) maintainableItems (Map)

See Also:

Serialized Form

Field Summary

protected boolean	defaultOpen
protected String	helpUrl
protected boolean	hidden
protected List<MaintainableItemDefinition>	maintainableItems
protected String	title

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

id

Constructor Summary

MaintainableSectionDefinition()

Method Summary

void	completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) Directly validate simple fields, call completeValidation on Definition fields.
String	getHelpUrl()
String	getId() Default the ID to the title for now.
List<MaintainableItemDefinition>	getMaintainableItems()
String	getTitle()
boolean	isDefaultOpen()
boolean	isHidden()
void	setDefaultOpen(boolean defaultOpen)
void	setHelpUrl(String helpUrl)
void	setHidden(boolean hidden) Whether to hide the entire section, tab and all.
void	setMaintainableItems(List<MaintainableItemDefinition> maintainableItems) The maintainableItems element defines the components of a section.
void	setTitle(String title) Sets title of the Section.
String	toString()

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

afterPropertiesSet, setId

Methods inherited from class java.lang.Object

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

Field Detail

title

protected String title

maintainableItems

protected List<MaintainableItemDefinition> maintainableItems

hidden

protected boolean hidden

defaultOpen

protected boolean defaultOpen

helpUrl

protected String helpUrl

Constructor Detail

MaintainableSectionDefinition

public MaintainableSectionDefinition()

Method Detail

getTitle

public String getTitle()

Returns:

title

getId

public String getId()

Default the ID to the title for now.

Specified by:

getId in interface DataDictionaryDefinition

Overrides:

getId in class DataDictionaryDefinitionBase

See Also:

DataDictionaryDefinitionBase.getId()

setTitle

public void setTitle(String title)

Sets title of the Section.

Throws:

IllegalArgumentException - if the given title is blank

getMaintainableItems

public List<MaintainableItemDefinition> getMaintainableItems()

Returns:

Collection of all MaintainableFieldDefinitions associated with this MaintainableSection, in the order in which they were added

completeValidation

public void completeValidation(Class rootBusinessObjectClass,
                               Class otherBusinessObjectClass)

Directly validate simple fields, call completeValidation on Definition fields.

Parameters:

rootBusinessObjectClass - Class of the BusinessObjectEntry which ultimately contains this definition

otherBusinessObjectClass - other stuff required to complete validation

See Also:

org.kuali.rice.kns.datadictionary.DataDictionaryDefinition#completeValidation(java.lang.Class, java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

isHidden

public boolean isHidden()

setHidden

public void setHidden(boolean hidden)

Whether to hide the entire section, tab and all.

setMaintainableItems

public void setMaintainableItems(List<MaintainableItemDefinition> maintainableItems)

The maintainableItems element defines the components of a section. These may include fields, sub-section headers, and fields. JSTL: maintainableItems is a Map which is accessed by a key of "maintainableItems". This map contains entries with the following keys: name of first item in the section name of second item in the section etc. The corresponding value is an ExportMap which is dependent upon the type of the item as follows: subSectionHeader ExportMap In this case, the ExportMap contains the following keys and values: Key** **Value** name name of subSectionHeader maintainableField ExportMap In this case, the ExportMap contains the following keys and values: Key** **Value** field true name name of maintainableField required true or false maintainableCollection ExportMap In this case, the ExportMap contains the following keys and values: Key** **Value** collection true name name of collection businessObjectClass name of collection class

isDefaultOpen

public boolean isDefaultOpen()

Returns:

the defaultOpen

setDefaultOpen

public void setDefaultOpen(boolean defaultOpen)

Parameters:

defaultOpen - the defaultOpen to set

getHelpUrl

public String getHelpUrl()

setHelpUrl

public void setHelpUrl(String helpUrl)