Package org.kuali.rice.krad.uif.view

Class MaintenanceDocumentView

java.lang.Object
org.kuali.rice.krad.datadictionary.DictionaryBeanBase
org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase
org.kuali.rice.krad.uif.component.ComponentBase
org.kuali.rice.krad.uif.container.ContainerBase
org.kuali.rice.krad.uif.view.View
org.kuali.rice.krad.uif.view.FormView
org.kuali.rice.krad.uif.view.DocumentView
org.kuali.rice.krad.uif.view.MaintenanceDocumentView
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, Ordered, ScriptEventSupport, Container, LifecycleElement, Helpable, org.springframework.core.Ordered
public class MaintenanceDocumentView extends DocumentView
View type for Maintenance documents

Supports primary display for a new maintenance record, in which case the fields are display for populating the new record, and an edit maintenance record, which is a comparison view with the old record read-only on the left side and the new record (changed record) on the right side

The MaintenanceDocumentView provides the interface for the maintenance framework. It works with the Maintainable service and maintenance controller.

Maintenance views are primarily configured by the object class they are associated with. This provides the default dictionary information for the fields. If more than one maintenance view is needed for the same object class, the view name can be used to further identify an unique view

Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • MaintenanceDocumentView

      public MaintenanceDocumentView()

  • Method Details

    • performInitialization

      public void performInitialization(Object model)
      The following initialization is performed:
      • Set the abstractTypeClasses map for the maintenance object path
      The following initialization is performed:
      • Retrieve the document entry
      • Makes sure that the header is set.
      • Set up the document view authorizer and presentation controller
      The following initialization is performed:
      • If a single paged view, set items in page group and put the page in the items list
      • If ViewSessionPolicy.enableTimeoutWarning is enabled add the session timeout dialogs to the views list of dialog groups
      The following initialization is performed:
      • Sorts the containers list of components
      • Initializes the instructional field if necessary
      • Initializes LayoutManager
      The following updates are done here:
      • Invoke performInitialize on component modifiers
      Initializes the component

      Where components can set defaults and setup other necessary state. The initialize method should only be called once per component lifecycle and is invoked within the initialize phase of the view lifecylce.

      Specified by:
      performInitialization in interface LifecycleElement
      Overrides:
      performInitialization in class DocumentView
      Parameters:
      model - - object instance containing the view data
      See Also:

    • getDocumentEntryForView

      protected MaintenanceDocumentEntry getDocumentEntryForView()
      Overrides to retrieve the a MaintenanceDocumentEntry based on the configured data object class
      Overrides:
      getDocumentEntryForView in class DocumentView
      Returns:
      MaintenanceDocumentEntry document entry (exception thrown if not found)

    • getDataObjectClassName

      public Class<?> getDataObjectClassName()
      Class name for the object the maintenance document applies to

      The object class name is used to pick up a dictionary entry which will feed the attribute field definitions and other configuration. In addition it is used to configure the Maintainable which will carry out the maintenance action

      Returns:
      maintenance object class

    • setDataObjectClassName

      public void setDataObjectClassName(Class<?> dataObjectClassName)
      See Also:

    • getDocTypeName

      public String getDocTypeName()
      Name for the document type the maintenance document applies to

      The document type name is used to pick up a dictionary entry which will feed the attribute field definitions and other configuration. In addition it is used to configure the Maintainable which will carry out the maintenance action

      Returns:
      document type name

    • setDocTypeName

      public void setDocTypeName(String docTypeName)
      See Also:

    • getOldObjectBindingPath

      public String getOldObjectBindingPath()
      Gives the binding path to the old object (record being edited) to display for comparison.
      Returns:
      old object binding path

    • setOldObjectBindingPath

      public void setOldObjectBindingPath(String oldObjectBindingPath)
      See Also:

    • getMaintenanceAction

      public String getMaintenanceAction()
      Indicates what maintenance action (new, edit, copy) was requested.
      Returns:
      maintenance action

    • setMaintenanceAction

      public void setMaintenanceAction(String maintenanceAction)
      See Also: