public interface DocumentControllerService extends ControllerService
| Modifier and Type | Method and Description |
|---|---|
org.springframework.web.servlet.ModelAndView |
acknowledge(DocumentFormBase form)
Sends a acknowledge workflow action for the document contained on the form.
|
org.springframework.web.servlet.ModelAndView |
approve(DocumentFormBase form)
Sends a approve workflow action for the document contained on the form.
|
org.springframework.web.servlet.ModelAndView |
blanketApprove(DocumentFormBase form)
Sends a blanket approve workflow action for the document contained on the form.
|
org.springframework.web.servlet.ModelAndView |
cancelAttachment(DocumentFormBase form)
Invoked to remove an attachment that was uploaded for the add note instance.
|
org.springframework.web.servlet.ModelAndView |
close(DocumentFormBase form)
Closes the document and returns to the hub.
|
org.springframework.web.servlet.ModelAndView |
complete(DocumentFormBase form)
Sends a complete workflow action for the document contained on the form.
|
org.springframework.web.servlet.ModelAndView |
deleteNote(DocumentFormBase form)
Invoked by the delete note action to delete a note instance contained on document (within the form).
|
org.springframework.web.servlet.ModelAndView |
disapprove(DocumentFormBase form)
Sends a disapprove workflow action for the document contained on the form.
|
org.springframework.web.servlet.ModelAndView |
docHandler(DocumentFormBase form)
Handles all requests for a new document instance or to load an existing document based on the
given form parameters.
|
org.springframework.web.servlet.ModelAndView |
downloadAttachment(DocumentFormBase form,
javax.servlet.http.HttpServletResponse response)
Invoked to download an attachment that has been uploaded for a note.
|
org.springframework.web.servlet.ModelAndView |
fyi(DocumentFormBase form)
Sends a fyi workflow action for the document contained on the form.
|
org.springframework.web.servlet.ModelAndView |
insertNote(DocumentFormBase form)
Invoked by the add note action to adding the note instance contained of the given form.
|
void |
performSuperUserWorkflowAction(DocumentFormBase form,
UifConstants.SuperUserWorkflowAction action)
Invokes the
DocumentService to carry out a super user request workflow action
and adds a success message. |
void |
performSuperUserWorkflowAction(DocumentFormBase form,
UifConstants.SuperUserWorkflowAction action,
ActionRequest actionRequest)
Invokes the
DocumentService to carry out a super user request workflow action
and adds a success message. |
void |
performWorkflowAction(DocumentFormBase form,
UifConstants.WorkflowAction action)
Invokes the
DocumentService to carry out a request workflow action and adds a
success message, if requested a check for sensitive data is also performed. |
void |
performWorkflowAction(DocumentFormBase form,
UifConstants.WorkflowAction action,
DocumentEvent documentEvent)
Invokes the
DocumentService to carry out a request workflow action and adds a
success message, if requested a check for sensitive data is also performed. |
org.springframework.web.servlet.ModelAndView |
recall(DocumentFormBase form)
Recalls the document with the given id on the form from workflow.
|
org.springframework.web.servlet.ModelAndView |
reload(DocumentFormBase form)
Reloads from the database the document with the doc id on the given form.
|
org.springframework.web.servlet.ModelAndView |
route(DocumentFormBase form)
Sends a route workflow action for the document contained on the form.
|
org.springframework.web.servlet.ModelAndView |
save(DocumentFormBase form)
Saves the document instance contained on the given form.
|
org.springframework.web.servlet.ModelAndView |
save(DocumentFormBase form,
SaveDocumentEvent saveDocumentEvent)
Saves the document instance contained on the given form and passes the given event for rule
evaluation.
|
org.springframework.web.servlet.ModelAndView |
sendAdHocRequests(DocumentFormBase form)
Sends AdHoc workflow Requests for the document instance contained on the form to the AdHoc recipients
contained on the form.
|
org.springframework.web.servlet.ModelAndView |
superUserApprove(DocumentFormBase form)
Sends a super user approve workflow action for the document contained on the form.
|
org.springframework.web.servlet.ModelAndView |
superUserDisapprove(DocumentFormBase form)
Sends a super user disapprove workflow action for the document contained on the form.
|
org.springframework.web.servlet.ModelAndView |
superUserTakeActions(DocumentFormBase form)
Invoked to take super user actions on a document.
|
org.springframework.web.servlet.ModelAndView |
supervisorFunctions(DocumentFormBase form)
Redirects to the supervisor workflow view.
|
cancel, checkViewAuthorization, sessionTimeout, startorg.springframework.web.servlet.ModelAndView docHandler(DocumentFormBase form) throws WorkflowException
form - form instance containing the document dataWorkflowException - if a document cannot be created or loadedorg.springframework.web.servlet.ModelAndView reload(DocumentFormBase form) throws WorkflowException
form - form instance containing the document id that will be reloadedWorkflowException - if the document cannot be reloadedorg.springframework.web.servlet.ModelAndView recall(DocumentFormBase form)
form - form instance containing the document id that will be recalledorg.springframework.web.servlet.ModelAndView save(DocumentFormBase form)
form - form instance containing the document that will be savedorg.springframework.web.servlet.ModelAndView save(DocumentFormBase form, SaveDocumentEvent saveDocumentEvent)
form - form instance containing the document that will be savedsaveDocumentEvent - rule event that will be processed with the save operationorg.springframework.web.servlet.ModelAndView complete(DocumentFormBase form)
form - form instance containing the document the complete request will be generated fororg.springframework.web.servlet.ModelAndView route(DocumentFormBase form)
form - form instance containing the document the route request will be generated fororg.springframework.web.servlet.ModelAndView blanketApprove(DocumentFormBase form)
form - form instance containing the document the blanket approve request will be generated fororg.springframework.web.servlet.ModelAndView approve(DocumentFormBase form)
form - form instance containing the document the approve request will be generated fororg.springframework.web.servlet.ModelAndView disapprove(DocumentFormBase form)
form - form instance containing the document the disapprove request will be generated fororg.springframework.web.servlet.ModelAndView fyi(DocumentFormBase form)
form - form instance containing the document the fyi request will be generated fororg.springframework.web.servlet.ModelAndView acknowledge(DocumentFormBase form)
form - form instance containing the document the acknowledge request will be generated fororg.springframework.web.servlet.ModelAndView sendAdHocRequests(DocumentFormBase form)
form - form instance containing the document and recipients the requests will be generated fororg.springframework.web.servlet.ModelAndView supervisorFunctions(DocumentFormBase form)
form - form instance containing the document instanceorg.springframework.web.servlet.ModelAndView close(DocumentFormBase form)
form - form instance containing the document instanceorg.springframework.web.servlet.ModelAndView insertNote(DocumentFormBase form)
form - form instance containing the note instanceorg.springframework.web.servlet.ModelAndView deleteNote(DocumentFormBase form)
form - form instance containing the note instanceorg.springframework.web.servlet.ModelAndView downloadAttachment(DocumentFormBase form, javax.servlet.http.HttpServletResponse response)
form - form instance containing the note (and attachment) instanceresponse - http servlet response instance for sending back the attachment contentsorg.springframework.web.servlet.ModelAndView cancelAttachment(DocumentFormBase form)
form - form instance containing the attachment.org.springframework.web.servlet.ModelAndView superUserTakeActions(DocumentFormBase form)
form - form instance containing the actions.org.springframework.web.servlet.ModelAndView superUserApprove(DocumentFormBase form)
form - form instance containing the document the super user approve request will be generated fororg.springframework.web.servlet.ModelAndView superUserDisapprove(DocumentFormBase form)
form - form instance containing the document the super user disapprove request will be generated forvoid performWorkflowAction(DocumentFormBase form, UifConstants.WorkflowAction action)
DocumentService to carry out a request workflow action and adds a
success message, if requested a check for sensitive data is also performed.form - document form instance containing the document for which the action will be taken onaction - UifConstants.WorkflowAction enum indicating what workflow action
to takevoid performWorkflowAction(DocumentFormBase form, UifConstants.WorkflowAction action, DocumentEvent documentEvent)
DocumentService to carry out a request workflow action and adds a
success message, if requested a check for sensitive data is also performed.form - document form instance containing the document for which the action will be taken onaction - UifConstants.WorkflowAction enum indicating what workflow action
to takedocumentEvent - rule event instance that will be evaluated with the workflow action, only currently
supported for the save actionvoid performSuperUserWorkflowAction(DocumentFormBase form, UifConstants.SuperUserWorkflowAction action)
DocumentService to carry out a super user request workflow action
and adds a success message.form - document form instance containing the document for which the super user action will be taken onaction - UifConstants.SuperUserWorkflowAction enum indicating what super
user workflow action to takevoid performSuperUserWorkflowAction(DocumentFormBase form, UifConstants.SuperUserWorkflowAction action, ActionRequest actionRequest)
DocumentService to carry out a super user request workflow action
and adds a success message.form - document form instance containing the document for which the super user action will be taken onaction - UifConstants.SuperUserWorkflowAction enum indicating what super
user workflow action to takeactionRequest - the requested action to take, currenly only available for take actionCopyright © 2005–2016 The Kuali Foundation. All rights reserved.