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, 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:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.krad.uif.view.View

applyDirtyCheck, viewIndex

Fields inherited from class org.kuali.rice.krad.uif.component.ComponentBase

templateOptions

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

componentCode

Fields inherited from interface org.kuali.rice.krad.uif.component.Ordered

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

MaintenanceDocumentView()

Method Summary

Class<?>	getDataObjectClassName() Class name for the object the maintenance document applies to
protected MaintenanceDocumentEntry	getDocumentEntryForView() Overrides to retrieve the a MaintenanceDocumentEntry based on the configured data object class
String	getMaintenanceAction() Indicates what maintenance action (new, edit, copy) was requested
String	getOldObjectBindingPath() Gives the binding path to the old object (record being edited) to display for comparison
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 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 Initializes the component
void	setDataObjectClassName(Class<?> dataObjectClassName) Setter for the object class name
void	setMaintenanceAction(String maintenanceAction) Setter for the maintenance action
void	setOldObjectBindingPath(String oldObjectBindingPath) Setter for the old object binding path

Methods inherited from class org.kuali.rice.krad.uif.view.DocumentView

getAttachmentTypesValuesFinderClass, getDocumentClass, isAllowsNoteAttachments, isAllowsNoteFYI, isDisplayTopicFieldInNotes, setAllowsNoteAttachments, setAllowsNoteFYI, setAttachmentTypesValuesFinderClass, setDisplayTopicFieldInNotes, setDocumentClass

Methods inherited from class org.kuali.rice.krad.uif.view.FormView

getAdditionalHiddenValues, getFormPostUrl, isRenderForm, isValidateClientSide, isValidateServerSide, performFinalize, setAdditionalHiddenValues, setFormPostUrl, setRenderForm, setValidateClientSide, setValidateServerSide

Methods inherited from class org.kuali.rice.krad.uif.view.View

addViewTemplate, clearIndex, clone, completeValidation, getActionFlags, getAdditionalCssFiles, getAdditionalHeadLinks, getAdditionalMetaTags, getAdditionalScriptFiles, getApplicationFooter, getApplicationHeader, getAuthorizer, getBreadcrumbItem, getBreadcrumbItems, getBreadcrumbOptions, getBreadcrumbs, getComponentTypeName, getContentContainerClassesAsString, getContentContainerCssClasses, getCurrentPage, getCurrentPageId, getDefaultBindingObjectPath, getDialogs, getEditModes, getEntryPageId, getExpressionVariables, getFormClass, getGrowls, getItems, getNamespaceCode, getNavigation, getNavigationBlockUI, getObjectPathToConcreteClassMapping, getPage, getPagesForPreprocessing, getParentLocation, getPathBasedBreadcrumbs, getPreLoadScript, getPreModelContext, getPresentationController, getRefreshBlockUI, getSessionPolicy, getStateMapping, getStateObjectBindingPath, getSupportedComponents, getTheme, getTopGroup, getViewHelperService, getViewHelperServiceClass, getViewIndex, getViewMenuGroupName, getViewMenuLink, getViewName, getViewRequestParameters, getViewTemplates, getViewTypeName, initializePendingTasks, isApplyDirtyCheck, isDisableBrowserCache, isDisableNativeAutocomplete, isGrowlMessagingEnabled, isMergeWithPageItems, isPersistFormToSession, isSinglePageView, isStickyApplicationFooter, isStickyApplicationHeader, isStickyBreadcrumbs, isStickyFooter, isStickyHeader, isStickyTopGroup, isSupportsRequestOverrideOfReadOnlyFields, isTranslateCodesOnReadOnlyDisplay, isUnifiedHeader, isUseLibraryCssClasses, notifyCompleted, performApplyModel, setActionFlags, setAdditionalCssFiles, setAdditionalHeadLinks, setAdditionalMetaTags, setAdditionalScriptFiles, setApplicationFooter, setApplicationHeader, setApplyDirtyCheck, setAuthorizer, setAuthorizerClass, setBreadcrumbItem, setBreadcrumbOptions, setBreadcrumbs, setContentContainerCssClasses, setCurrentPageId, setDefaultBindingObjectPath, setDialogs, setDisableBrowserCache, setDisableNativeAutocomplete, setEditModes, setEntryPageId, setExpressionVariables, setFormClass, setGrowlMessagingEnabled, setGrowls, setItems, setMergeWithPageItems, setNamespaceCode, setNavigation, setNavigationBlockUI, setObjectPathToConcreteClassMapping, setPage, setParentLocation, setPathBasedBreadcrumbs, setPersistFormToSession, setPreLoadScript, setPresentationController, setPresentationControllerClass, setRefreshBlockUI, setSessionPolicy, setSinglePageView, setStateMapping, setStateObjectBindingPath, setStickyApplicationFooter, setStickyApplicationHeader, setStickyBreadcrumbs, setStickyFooter, setStickyHeader, setStickyTopGroup, setSupportsRequestOverrideOfReadOnlyFields, setTheme, setTopGroup, setTranslateCodesOnReadOnlyDisplay, setUnifiedHeader, setUseLibraryCssClasses, setViewHelperService, setViewHelperServiceClass, setViewMenuGroupName, setViewMenuLink, setViewName, setViewRequestParameters, setViewTemplates, setViewTypeName, sortItems

Methods inherited from class org.kuali.rice.krad.uif.container.ContainerBase

getAdditionalTemplates, getDefaultItemPosition, getFooter, getHeader, getHeaderText, getHelp, getHelpTitle, getInstructionalMessage, getInstructionalText, getLayoutManager, getValidationMessages, isProcessRemoteFieldHolders, setDefaultItemPosition, setFooter, setHeader, setHeaderText, setHelp, setInstructionalMessage, setInstructionalText, setLayoutManager, setRenderFooter, setRenderHeader, setTooltipOfComponent, setValidationMessages

Methods inherited from class org.kuali.rice.krad.uif.component.ComponentBase

addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, checkMutable, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContainerIdSuffix, getContext, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnInputScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getPhasePathMapping, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getViewPath, getViewStatus, getWidth, getWrapperCssClasses, getWrapperCssClassesAsString, getWrapperStyle, initializeComponentSecurity, isDisableSessionPersistence, isDisclosedByAction, isEditAuthz, isFinal, isForceSessionPersistence, isHidden, isInitialized, isModelApplied, isMutable, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, isSkipInTabOrder, isViewAuthz, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContainerIdSuffix, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setEditAuthz, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setMethodToCallOnRefresh, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnInputScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPhasePathMapping, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRowSpan, setScriptDataAttributes, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewAuthz, setViewPath, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle, skipLifecycle

Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

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

dataDictionaryPostProcessing, getComponentCode, setComponentCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.uif.component.Component

addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAlign, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getCssClasses, getDataAttributes, getEventHandlerScript, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getLibraryCssClasses, getMethodToCallOnRefresh, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, getWrapperCssClasses, getWrapperStyle, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setCellWidth, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setLibraryCssClasses, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRowSpan, setScriptDataAttributes, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle

Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

dataDictionaryPostProcessing, getComponentCode

Methods inherited from interface org.kuali.rice.krad.uif.util.LifecycleElement

checkMutable, getContainerIdSuffix, getContext, getId, getPhasePathMapping, getViewPath, getViewStatus, isFinal, isInitialized, isModelApplied, isMutable, isRender, pushAllToContext, pushObjectToContext, setContainerIdSuffix, setContext, setId, setPhasePathMapping, setRender, setViewPath, skipLifecycle

Methods inherited from interface org.kuali.rice.krad.uif.component.ScriptEventSupport

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnInputScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnInputScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript

Constructor Detail

MaintenanceDocumentView

public MaintenanceDocumentView()

Method Detail

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
• 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

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:

ComponentDefaultInitializeTask

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)

Setter for the object class name

Parameters:

dataObjectClassName -

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)

Setter for the old object binding path

Parameters:

oldObjectBindingPath -

getMaintenanceAction

public String getMaintenanceAction()

Indicates what maintenance action (new, edit, copy) was requested

Returns:

maintenance action

setMaintenanceAction

public void setMaintenanceAction(String maintenanceAction)

Setter for the maintenance action

Parameters:

maintenanceAction -