Package org.kuali.rice.krad.maintenance

Interface MaintenanceDocumentControllerService

All Superinterfaces:

ControllerService, DocumentControllerService

All Known Implementing Classes:

MaintenanceDocumentControllerServiceImpl

public interface MaintenanceDocumentControllerService
extends DocumentControllerService

Controller service that extends DocumentControllerService and adds methods specific to maintenance documents.

Author:

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

Method Summary

Modifier and Type	Method	Description
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.
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.

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

cancel, checkViewAuthorization, sessionTimeout, start

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

Method Details

setupMaintenanceEdit

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.

Parameters:

form - form instance containing the maintenance data

Returns:

ModelAndView instance for rendering the edit maintenance view

setupMaintenanceCopy

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.

Parameters:

form - form instance containing the maintenance data

Returns:

ModelAndView instance for rendering the copy maintenance view

setupMaintenanceNewWithExisting

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.

Parameters:

form - form instance containing the maintenance data

Returns:

ModelAndView instance for rendering the new maintenance view

setupMaintenanceDelete

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.

Parameters:

form - form instance containing the maintenance data

Returns:

ModelAndView instance for rendering the delete maintenance view

setupMaintenanceDocument

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.

Parameters:

form - form instance containing the maintenance data

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

downloadDataObjectAttachment

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.

Parameters:

form - form instance containing the maintenance data

response - Http response for returning the attachment contents