Package org.kuali.rice.kns.datadictionary

Class MaintainableSectionDefinition

java.lang.Object
org.kuali.rice.krad.datadictionary.DictionaryBeanBase
org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase
org.kuali.rice.kns.datadictionary.MaintainableSectionDefinition
All Implemented Interfaces:
Serializable, Cloneable, org.kuali.rice.krad.datadictionary.Copyable, org.kuali.rice.krad.datadictionary.DataDictionaryDefinition, org.kuali.rice.krad.datadictionary.DictionaryBean
@Deprecated public class MaintainableSectionDefinition extends org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase
Deprecated.
Use sections inside of MaintenanceDocumentView.
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:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected boolean
    defaultOpen
    Deprecated.
     
    protected String
    helpUrl
    Deprecated.
     
    protected boolean
    hidden
    Deprecated.
     
    protected List<MaintainableItemDefinition>
    maintainableItems
    Deprecated.
     
    protected String
    title
    Deprecated.
     

    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

    Constructors
    Constructor
    Description
    MaintainableSectionDefinition()
    Deprecated.
     

  • Method Summary

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

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

    completeValidation, hasEmbeddedDataObjectMetadata, setEmbeddedDataObjectMetadata, setGeneratedFromMetadata, setId, wasGeneratedFromMetadata

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

    clone, copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, 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 Details

    • title

      protected String title
      Deprecated.

    • maintainableItems

      protected List<MaintainableItemDefinition> maintainableItems
      Deprecated.

    • hidden

      protected boolean hidden
      Deprecated.

    • defaultOpen

      protected boolean defaultOpen
      Deprecated.

    • helpUrl

      protected String helpUrl
      Deprecated.

  • Constructor Details

    • MaintainableSectionDefinition

      public MaintainableSectionDefinition()
      Deprecated.

  • Method Details

    • getTitle

      public String getTitle()
      Deprecated.
      Returns:
      title

    • getId

      public String getId()
      Deprecated.
      Default the ID to the title for now.
      Specified by:
      getId in interface org.kuali.rice.krad.datadictionary.DataDictionaryDefinition
      Overrides:
      getId in class org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase
      See Also:
      • DataDictionaryDefinitionBase.getId()

    • setTitle

      public void setTitle(String title)
      Deprecated.
      Sets title of the Section.
      Throws:
      IllegalArgumentException - if the given title is blank

    • getMaintainableItems

      public List<MaintainableItemDefinition> getMaintainableItems()
      Deprecated.
      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)
      Deprecated.
      Directly validate simple fields, call completeValidation on Definition fields.
      Specified by:
      completeValidation in interface org.kuali.rice.krad.datadictionary.DataDictionaryDefinition
      Overrides:
      completeValidation in class org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase
      See Also:
      • DataDictionaryDefinition.completeValidation(Class, Class)

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object

    • isHidden

      public boolean isHidden()
      Deprecated.

    • setHidden

      public void setHidden(boolean hidden)
      Deprecated.
      Whether to hide the entire section, tab and all.

    • setMaintainableItems

      public void setMaintainableItems(List<MaintainableItemDefinition> maintainableItems)
      Deprecated.
      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 dataObjectClass name of collection class

    • isDefaultOpen

      public boolean isDefaultOpen()
      Deprecated.
      Returns:
      the defaultOpen

    • setDefaultOpen

      public void setDefaultOpen(boolean defaultOpen)
      Deprecated.
      Parameters:
      defaultOpen - the defaultOpen to set

    • getHelpUrl

      public String getHelpUrl()
      Deprecated.

    • setHelpUrl

      public void setHelpUrl(String helpUrl)
      Deprecated.