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, DictionaryBean, UifDictionaryBean, Component, ScriptEventSupport, Container, 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 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(View view, Object model) The following initialization is performed: Set the abstractTypeClasses map for the maintenance object path
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

getFormPostUrl, isRenderForm, isValidateClientSide, isValidateServerSide, setFormPostUrl, setRenderForm, setValidateClientSide, setValidateServerSide

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

addToClientSideState, assignComponentIds, completeValidation, getActionFlags, getAdditionalCssFiles, getAdditionalScriptFiles, getApplicationFooter, getApplicationHeader, getAuthorizer, getBreadcrumbs, getBreadcrumbTitleDisplayOption, getBreadcrumbTitlePropertyName, getClientSideState, getComponentsForLifecycle, getComponentTypeName, getCurrentPage, getCurrentPageId, getDefaultBindingObjectPath, getDialogs, getEditModes, getEntryPageId, getExpressionVariables, getFormClass, getGrowls, getIdSequence, getItems, getNamespaceCode, getNavigation, getNavigationBlockUI, getNextId, getObjectPathToConcreteClassMapping, getPage, getPreloadPoolSize, getPreLoadScript, getPresentationController, getRefreshBlockUI, getStateMapping, getStateObjectBindingPath, getSupportedComponents, getTheme, getViewHelperService, getViewHelperServiceClass, getViewIndex, getViewMenuGroupName, getViewMenuLink, getViewName, getViewRequestParameters, getViewStatus, getViewTemplates, getViewTypeName, index, isApplyDirtyCheck, isFinal, isGrowlMessagingEnabled, isInitialized, isPersistFormToSession, isRenderBreadcrumbsInView, isSinglePageView, isSupportsRequestOverrideOfReadOnlyFields, isTranslateCodesOnReadOnlyDisplay, performApplyModel, performFinalize, setActionFlags, setAdditionalCssFiles, setAdditionalScriptFiles, setApplicationFooter, setApplicationHeader, setApplyDirtyCheck, setAuthorizer, setAuthorizerClass, setBreadcrumbs, setBreadcrumbTitleDisplayOption, setBreadcrumbTitlePropertyName, setClientSideState, setCurrentPageId, setDefaultBindingObjectPath, setDialogs, setEditModes, setEntryPageId, setExpressionVariables, setFormClass, setGrowlMessagingEnabled, setGrowls, setIdSequence, setItems, setNamespaceCode, setNavigation, setNavigationBlockUI, setObjectPathToConcreteClassMapping, setPage, setPersistFormToSession, setPreloadPoolSize, setPreLoadScript, setPresentationController, setPresentationControllerClass, setRefreshBlockUI, setRenderBreadcrumbsInView, setSinglePageView, setStateMapping, setStateObjectBindingPath, setSupportsRequestOverrideOfReadOnlyFields, setTheme, setTranslateCodesOnReadOnlyDisplay, setViewHelperServiceClass, setViewMenuGroupName, setViewMenuLink, setViewName, setViewRequestParameters, setViewStatus, setViewTemplates, setViewTypeName, sortItems

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

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

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

addCellCssClass, addDataAttribute, addDataAttributeIfNonEmpty, addStyleClass, appendToStyle, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAlign, getAllDataAttributesJs, getBaseId, getCellCssClasses, getCellStyleClassesAsString, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentSecurity, getComponentSecurityClass, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAlign, setBaseId, setCellCssClasses, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setMethodToCallOnRefresh, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setWidth

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

getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph

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

getComponentCode, setComponentCode

Methods inherited from class java.lang.Object

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

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

addCellCssClass, addDataAttribute, addStyleClass, appendToStyle, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAllDataAttributesJs, getBaseId, getCellCssClasses, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, pushAllToContext, pushObjectToContext, setAdditionalComponentsToRefresh, setBaseId, setCellCssClasses, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setForceSessionPersistence, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip

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

getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph

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

getComponentCode

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

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, setOnBlurScript, setOnLoadScript

Constructor Detail

MaintenanceDocumentView

public MaintenanceDocumentView()

Method Detail

performInitialization

public void performInitialization(View view,
                                  Object model)

The following initialization is performed:

• Set the abstractTypeClasses map for the maintenance object path

Specified by:

performInitialization in interface Component

Overrides:

performInitialization in class DocumentView

Parameters:

view - - view instance in which the component belongs

model - - object instance containing the view data

See Also:

ContainerBase.performInitialization(org.kuali.rice.krad.uif.view.View, java.lang.Object)

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:

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

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

String maintenance action

setMaintenanceAction

public void setMaintenanceAction(String maintenanceAction)

Setter for the maintenance action

Parameters:

maintenanceAction -