org.kuali.rice.krad.uif.view
Class MaintenanceView

java.lang.Object
  extended by org.kuali.rice.krad.uif.component.ConfigurableBase
      extended by org.kuali.rice.krad.uif.component.ComponentBase
          extended by org.kuali.rice.krad.uif.container.ContainerBase
              extended by org.kuali.rice.krad.uif.view.View
                  extended by org.kuali.rice.krad.uif.view.FormView
                      extended by org.kuali.rice.krad.uif.view.DocumentView
                          extended by org.kuali.rice.krad.uif.view.MaintenanceView
All Implemented Interfaces:
Serializable, Component, Configurable, ScriptEventSupport, Container, Helpable, org.springframework.core.Ordered

public class MaintenanceView
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 MaintenanceView 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
MaintenanceView()
           
 
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, getActionFlags, getAdditionalCssFiles, getAdditionalScriptFiles, getApplicationFooter, getApplicationHeader, getAuthorizer, getBreadcrumbs, getBreadcrumbTitleDisplayOption, getBreadcrumbTitlePropertyName, getClientSideState, getComponentPrototypes, getComponentsForLifecycle, getComponentTypeName, getCurrentPage, getCurrentPageId, getDefaultBindingObjectPath, getDialogs, getEditModes, getEntryPageId, getExpressionVariables, getFormClass, getGrowls, getIdSequence, getItems, getNamespaceCode, getNavigation, getNextId, getObjectPathToConcreteClassMapping, getPage, getPreloadPoolSize, getPreLoadScript, getPresentationController, getStateMapping, getStateObjectBindingPath, getSupportedComponents, getTheme, getViewHelperService, getViewHelperServiceClass, getViewIndex, getViewMenuGroupName, getViewMenuLink, getViewName, getViewRequestParameters, getViewStatus, 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, setObjectPathToConcreteClassMapping, setPage, setPersistFormToSession, setPreloadPoolSize, setPreLoadScript, setPresentationController, setPresentationControllerClass, setRenderBreadcrumbsInView, setSinglePageView, setStateMapping, setStateObjectBindingPath, setSupportsRequestOverrideOfReadOnlyFields, setTheme, setTranslateCodesOnReadOnlyDisplay, setViewHelperServiceClass, setViewMenuGroupName, setViewMenuLink, setViewName, setViewRequestParameters, setViewStatus, setViewTypeName
 
Methods inherited from class org.kuali.rice.krad.uif.container.ContainerBase
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
addDataAttribute, addStyleClass, appendToStyle, getAlign, getAllDataAttributesJs, getBaseId, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentSecurity, getComponentSecurityClass, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getDataMetaAttribute, getDataRoleAttribute, getDataTypeAttribute, 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, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, isDisableSessionPersistence, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setBaseId, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDataMetaAttribute, setDataRoleAttribute, setDataTypeAttribute, setDisableSessionPersistence, 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, 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.uif.component.ConfigurableBase
getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph
 
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
addDataAttribute, addStyleClass, appendToStyle, getAllDataAttributesJs, getBaseId, getColSpan, getComplexDataAttributesJs, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getDataAttributes, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRowSpan, getSimpleDataAttributes, getStyle, getTemplate, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, isDisableSessionPersistence, isForceSessionPersistence, isHidden, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, pushAllToContext, pushObjectToContext, setBaseId, setColSpan, setComponentModifiers, setComponentSecurity, setConditionalRefresh, setContext, setCssClasses, setDataAttributes, setDisableSessionPersistence, setForceSessionPersistence, setHidden, setId, setOrder, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setTemplate, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip
 
Methods inherited from interface org.kuali.rice.krad.uif.component.Configurable
getExpressionGraph, getPropertyExpression, getPropertyExpressions, getRefreshExpressionGraph, setExpressionGraph, setPropertyExpressions, setRefreshExpressionGraph
 
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

MaintenanceView

public MaintenanceView()
Method Detail

performInitialization

public void performInitialization(View view,
                                  Object model)
The following initialization is performed:

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 -


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.