Package org.kuali.rice.krad.document

Interface DocumentControllerService

All Superinterfaces:
ControllerService
All Known Subinterfaces:
MaintenanceDocumentControllerService, TransactionalDocumentControllerService
All Known Implementing Classes:
DocumentControllerServiceImpl, MaintenanceDocumentControllerServiceImpl, TransactionalDocumentControllerServiceImpl
public interface DocumentControllerService extends ControllerService
Controller service that handles document specific actions (such as workflow actions).
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Details

    • docHandler

      org.springframework.web.servlet.ModelAndView docHandler(DocumentFormBase form) throws org.kuali.rice.kew.api.exception.WorkflowException
      Handles all requests for a new document instance or to load an existing document based on the given form parameters.
      Parameters:
      form - form instance containing the document data
      Returns:
      ModelAndView instance for rendering the document view
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException - if a document cannot be created or loaded

    • reload

      org.springframework.web.servlet.ModelAndView reload(DocumentFormBase form) throws org.kuali.rice.kew.api.exception.WorkflowException
      Reloads from the database the document with the doc id on the given form.
      Parameters:
      form - form instance containing the document id that will be reloaded
      Returns:
      ModelAndView instance for rendering the reloaded document view
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException - if the document cannot be reloaded

    • recall

      org.springframework.web.servlet.ModelAndView recall(DocumentFormBase form)
      Recalls the document with the given id on the form from workflow.
      Parameters:
      form - form instance containing the document id that will be recalled
      Returns:
      ModelAndView instance for rendering the document view

    • save

      org.springframework.web.servlet.ModelAndView save(DocumentFormBase form)
      Saves the document instance contained on the given form.
      Parameters:
      form - form instance containing the document that will be saved
      Returns:
      ModelAndView instance for rendering the document view

    • save

      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.
      Parameters:
      form - form instance containing the document that will be saved
      saveDocumentEvent - rule event that will be processed with the save operation
      Returns:
      ModelAndView instance for rendering the document view

    • complete

      org.springframework.web.servlet.ModelAndView complete(DocumentFormBase form)
      Sends a complete workflow action for the document contained on the form.
      Parameters:
      form - form instance containing the document the complete request will be generated for
      Returns:
      ModelAndView instance for rendering the document view

    • route

      org.springframework.web.servlet.ModelAndView route(DocumentFormBase form)
      Sends a route workflow action for the document contained on the form.
      Parameters:
      form - form instance containing the document the route request will be generated for
      Returns:
      ModelAndView instance for rendering the document view

    • blanketApprove

      org.springframework.web.servlet.ModelAndView blanketApprove(DocumentFormBase form)
      Sends a blanket approve workflow action for the document contained on the form.
      Parameters:
      form - form instance containing the document the blanket approve request will be generated for
      Returns:
      ModelAndView instance for rendering the document view

    • approve

      org.springframework.web.servlet.ModelAndView approve(DocumentFormBase form)
      Sends a approve workflow action for the document contained on the form.
      Parameters:
      form - form instance containing the document the approve request will be generated for
      Returns:
      ModelAndView instance for rendering the document view

    • disapprove

      org.springframework.web.servlet.ModelAndView disapprove(DocumentFormBase form)
      Sends a disapprove workflow action for the document contained on the form.
      Parameters:
      form - form instance containing the document the disapprove request will be generated for
      Returns:
      ModelAndView instance for rendering the document view

    • fyi

      org.springframework.web.servlet.ModelAndView fyi(DocumentFormBase form)
      Sends a fyi workflow action for the document contained on the form.
      Parameters:
      form - form instance containing the document the fyi request will be generated for
      Returns:
      ModelAndView instance for rendering the document view

    • acknowledge

      org.springframework.web.servlet.ModelAndView acknowledge(DocumentFormBase form)
      Sends a acknowledge workflow action for the document contained on the form.
      Parameters:
      form - form instance containing the document the acknowledge request will be generated for
      Returns:
      ModelAndView instance for rendering the document view

    • sendAdHocRequests

      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.
      Parameters:
      form - form instance containing the document and recipients the requests will be generated for
      Returns:
      ModelAndView instance for rendering the document view

    • supervisorFunctions

      org.springframework.web.servlet.ModelAndView supervisorFunctions(DocumentFormBase form)
      Redirects to the supervisor workflow view.
      Parameters:
      form - form instance containing the document instance
      Returns:
      ModelAndView instance for rendering the supervisor workflow view

    • close

      org.springframework.web.servlet.ModelAndView close(DocumentFormBase form)
      Closes the document and returns to the hub.
      Parameters:
      form - form instance containing the document instance
      Returns:
      ModelAndView instance for rendering the document view

    • insertNote

      org.springframework.web.servlet.ModelAndView insertNote(DocumentFormBase form)
      Invoked by the add note action to adding the note instance contained of the given form.
      Parameters:
      form - form instance containing the note instance
      Returns:
      ModelAndView instance for rendering the document view

    • deleteNote

      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).
      Parameters:
      form - form instance containing the note instance
      Returns:
      ModelAndView instance for rendering the document view

    • downloadAttachment

      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.
      Parameters:
      form - form instance containing the note (and attachment) instance
      response - http servlet response instance for sending back the attachment contents
      Returns:
      ModelAndView instance for rendering the document view, or null if the response has been finished

    • cancelAttachment

      org.springframework.web.servlet.ModelAndView cancelAttachment(DocumentFormBase form)
      Invoked to remove an attachment that was uploaded for the add note instance.
      Parameters:
      form - form instance containing the attachment.
      Returns:
      ModelAndView instance for rendering the document view

    • superUserTakeActions

      org.springframework.web.servlet.ModelAndView superUserTakeActions(DocumentFormBase form)
      Invoked to take super user actions on a document.
      Parameters:
      form - form instance containing the actions.
      Returns:
      ModelAndView instance for rendering the document view

    • superUserApprove

      org.springframework.web.servlet.ModelAndView superUserApprove(DocumentFormBase form)
      Sends a super user approve workflow action for the document contained on the form.
      Parameters:
      form - form instance containing the document the super user approve request will be generated for
      Returns:
      ModelAndView instance for rendering the document view

    • superUserDisapprove

      org.springframework.web.servlet.ModelAndView superUserDisapprove(DocumentFormBase form)
      Sends a super user disapprove workflow action for the document contained on the form.
      Parameters:
      form - form instance containing the document the super user disapprove request will be generated for
      Returns:
      ModelAndView instance for rendering the document view

    • performWorkflowAction

      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.
      Parameters:
      form - document form instance containing the document for which the action will be taken on
      action - UifConstants.WorkflowAction enum indicating what workflow action to take

    • performWorkflowAction

      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.
      Parameters:
      form - document form instance containing the document for which the action will be taken on
      action - UifConstants.WorkflowAction enum indicating what workflow action to take
      documentEvent - rule event instance that will be evaluated with the workflow action, only currently supported for the save action

    • performSuperUserWorkflowAction

      void performSuperUserWorkflowAction(DocumentFormBase form, UifConstants.SuperUserWorkflowAction action)
      Invokes the DocumentService to carry out a super user request workflow action and adds a success message.
      Parameters:
      form - document form instance containing the document for which the super user action will be taken on
      action - UifConstants.SuperUserWorkflowAction enum indicating what super user workflow action to take

    • performSuperUserWorkflowAction

      void performSuperUserWorkflowAction(DocumentFormBase form, UifConstants.SuperUserWorkflowAction action, org.kuali.rice.kew.api.action.ActionRequest actionRequest)
      Invokes the DocumentService to carry out a super user request workflow action and adds a success message.
      Parameters:
      form - document form instance containing the document for which the super user action will be taken on
      action - UifConstants.SuperUserWorkflowAction enum indicating what super user workflow action to take
      actionRequest - the requested action to take, currenly only available for take action