org.kuali.rice.krad.maintenance

Class MaintenanceDocumentControllerServiceImpl

java.lang.Object

org.kuali.rice.krad.web.service.impl.ControllerServiceImpl

org.kuali.rice.krad.document.DocumentControllerServiceImpl

org.kuali.rice.krad.maintenance.MaintenanceDocumentControllerServiceImpl

All Implemented Interfaces:

DocumentControllerService, MaintenanceDocumentControllerService, ControllerService

public class MaintenanceDocumentControllerServiceImpl
extends DocumentControllerServiceImpl
implements MaintenanceDocumentControllerService

Default implementation of the maintenance document controller service.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Field Summary

Fields inherited from class org.kuali.rice.krad.document.DocumentControllerServiceImpl

DOCUMENT_LOAD_COMMANDS, EXPLANATION_DIALOG, SENSITIVE_DATA_DIALOG

Constructor Summary

Constructors

Constructor and Description
MaintenanceDocumentControllerServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	createDocument(DocumentFormBase form) Creates a new document of the type specified by the docTypeName property of the given form.
protected void	createMaintenanceDocument(MaintenanceDocumentForm form, String maintenanceAction) Helper method to create a new maintenance document instance and set the instance on the given form.
void	downloadDataObjectAttachment(MaintenanceDocumentForm form, javax.servlet.http.HttpServletResponse response) When the maintenance data object is a PersistableAttachment or PersistableAttachmentList, streams the selected attachment back to the response.
protected MaintenanceDocumentService	getMaintenanceDocumentService()
protected void	loadDocument(DocumentFormBase form) Loads the document by its provided document header id on the given form.
void	setMaintenanceDocumentService(MaintenanceDocumentService maintenanceDocumentService)
org.springframework.web.servlet.ModelAndView	setupMaintenanceCopy(MaintenanceDocumentForm form) Sets up a new maintenance document for a copy action on the data object identified by the form parameters.
org.springframework.web.servlet.ModelAndView	setupMaintenanceDelete(MaintenanceDocumentForm form) Sets up a new maintenance document for a delete action on the data object identified by the form parameters.
void	setupMaintenanceDocument(MaintenanceDocumentForm form, String maintenanceAction) Invoked to setup a new maintenance document for the maintenance data contained on the form and the given maintenance action.
org.springframework.web.servlet.ModelAndView	setupMaintenanceEdit(MaintenanceDocumentForm form) Sets up a new maintenance document for an edit action on the data object identified by the form parameters.
org.springframework.web.servlet.ModelAndView	setupMaintenanceNewWithExisting(MaintenanceDocumentForm form) Sets up a new maintenance document for a new with existing action on the data object identified by the form parameters.
org.springframework.web.servlet.ModelAndView	start(UifFormBase form) Initial method called when requesting a new view instance.

Methods inherited from class org.kuali.rice.krad.document.DocumentControllerServiceImpl

acknowledge, approve, blanketApprove, buildAuthorizationException, cancel, cancelAttachment, checkSensitiveDataAndWarningDialog, close, combineAdHocRecipients, complete, deleteNote, disapprove, docHandler, downloadAttachment, fyi, generateDisapprovalNote, getAddLineNoteInstance, getAttachmentService, getCollectionControllerService, getConfigurationService, getDataDictionaryService, getDocumentDictionaryService, getDocumentService, getLegacyDataAdapter, getModelAndViewService, getNavigationControllerService, getNewNoteAttachment, getNoteService, getParameterService, getWorkflowDocumentActionsService, insertNote, performSuperUserWorkflowAction, performSuperUserWorkflowAction, performWorkflowAction, performWorkflowAction, recall, reload, route, save, save, saveNewNote, sendAdHocRequests, setAttachmentService, setCollectionControllerService, setConfigurationService, setDataDictionaryService, setDocumentDictionaryService, setDocumentService, setLegacyDataAdapter, setModelAndViewService, setNavigationControllerService, setNewNoteProperties, setNoteService, setParameterService, superUserApprove, superUserDisapprove, superUserTakeActions, supervisorFunctions

Methods inherited from class org.kuali.rice.krad.web.service.impl.ControllerServiceImpl

checkViewAuthorization, sessionTimeout

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.document.DocumentControllerService

acknowledge, approve, blanketApprove, cancelAttachment, close, complete, deleteNote, disapprove, docHandler, downloadAttachment, fyi, insertNote, performSuperUserWorkflowAction, performSuperUserWorkflowAction, performWorkflowAction, performWorkflowAction, recall, reload, route, save, save, sendAdHocRequests, superUserApprove, superUserDisapprove, superUserTakeActions, supervisorFunctions

Methods inherited from interface org.kuali.rice.krad.web.service.ControllerService

cancel, checkViewAuthorization, sessionTimeout

Constructor Detail

MaintenanceDocumentControllerServiceImpl

public MaintenanceDocumentControllerServiceImpl()

Method Detail

start

public org.springframework.web.servlet.ModelAndView start(UifFormBase form)

Initial method called when requesting a new view instance.

Specified by:

start in interface ControllerService

Overrides:

start in class ControllerServiceImpl

Parameters:

form - form instance containing the model data

Returns:

ModelAndView instance for rendering the view

loadDocument

protected void loadDocument(DocumentFormBase form)
                     throws WorkflowException

Loads the document by its provided document header id on the given form.

This has been abstracted out so that it can be overridden in children if the need arises

Overrides:

loadDocument in class DocumentControllerServiceImpl

Parameters:

form - form instance that contains the doc id parameter and where the retrieved document instance should be set

Throws:

WorkflowException

createDocument

protected void createDocument(DocumentFormBase form)
                       throws WorkflowException

Creates a new document of the type specified by the docTypeName property of the given form.

This has been abstracted out so that it can be overridden in children if the need arises

Overrides:

createDocument in class DocumentControllerServiceImpl

Parameters:

form - form instance that contains the doc type parameter and where the new document instance should be set

Throws:

WorkflowException

setupMaintenanceEdit

public org.springframework.web.servlet.ModelAndView setupMaintenanceEdit(MaintenanceDocumentForm form)

Sets up a new maintenance document for an edit action on the data object identified by the form parameters.

Specified by:

setupMaintenanceEdit in interface MaintenanceDocumentControllerService

Parameters:

form - form instance containing the maintenance data

Returns:

ModelAndView instance for rendering the edit maintenance view

setupMaintenanceCopy

public org.springframework.web.servlet.ModelAndView setupMaintenanceCopy(MaintenanceDocumentForm form)

Sets up a new maintenance document for a copy action on the data object identified by the form parameters.

Specified by:

setupMaintenanceCopy in interface MaintenanceDocumentControllerService

Parameters:

form - form instance containing the maintenance data

Returns:

ModelAndView instance for rendering the copy maintenance view

setupMaintenanceNewWithExisting

public org.springframework.web.servlet.ModelAndView setupMaintenanceNewWithExisting(MaintenanceDocumentForm form)

Sets up a new maintenance document for a new with existing action on the data object identified by the form parameters.

Specified by:

setupMaintenanceNewWithExisting in interface MaintenanceDocumentControllerService

Parameters:

form - form instance containing the maintenance data

Returns:

ModelAndView instance for rendering the new maintenance view

setupMaintenanceDelete

public org.springframework.web.servlet.ModelAndView setupMaintenanceDelete(MaintenanceDocumentForm form)

Sets up a new maintenance document for a delete action on the data object identified by the form parameters.

Specified by:

setupMaintenanceDelete in interface MaintenanceDocumentControllerService

Parameters:

form - form instance containing the maintenance data

Returns:

ModelAndView instance for rendering the delete maintenance view

setupMaintenanceDocument

public void setupMaintenanceDocument(MaintenanceDocumentForm form,
                            String maintenanceAction)

Invoked to setup a new maintenance document for the maintenance data contained on the form and the given maintenance action.

Specified by:

setupMaintenanceDocument in interface MaintenanceDocumentControllerService

Parameters:

form - form instance containing the maintenance data

maintenanceAction - type of maintenance action being requested (new, edit, copy, delete)

createMaintenanceDocument

protected void createMaintenanceDocument(MaintenanceDocumentForm form,
                             String maintenanceAction)

Helper method to create a new maintenance document instance and set the instance on the given form.

Parameters:

form - form instance to pull data object from and set new document instance on

maintenanceAction - type of maintenance action being requested

downloadDataObjectAttachment

public void downloadDataObjectAttachment(MaintenanceDocumentForm form,
                                javax.servlet.http.HttpServletResponse response)

When the maintenance data object is a PersistableAttachment or PersistableAttachmentList, streams the selected attachment back to the response.

Specified by:

downloadDataObjectAttachment in interface MaintenanceDocumentControllerService

Parameters:

form - form instance containing the maintenance data

response - Http response for returning the attachment contents

getMaintenanceDocumentService

protected MaintenanceDocumentService getMaintenanceDocumentService()

setMaintenanceDocumentService

public void setMaintenanceDocumentService(MaintenanceDocumentService maintenanceDocumentService)