Package org.kuali.rice.krad.workflow.service

Interface WorkflowDocumentService

public interface WorkflowDocumentService
This interface defines the contract that must be implemented by the workflow engine.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    acknowledge(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRecipients)
     
    void
    acknowledge(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients)
    acknowledge this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken, additionally optionally providing a list of ad hoc recipients for this document which should be restricted to actions requested of acknowledge or fyi as all other action request types will be discarded
    void
    approve(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRecipients)
     
    void
    approve(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients)
    approve this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken, and additionally optionally providing a list of ad hoc recipients for the document
    void
    blanketApprove(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRecipients)
     
    void
    blanketApprove(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients)
    blanket approve this document optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken, and additionally optionally providing a list of ad hoc recipients for this document which should be restricted to actions requested of acknowledge or fyi as all other action request types will be discarded.
    void
    cancel(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation)
    cancel this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
    void
    clearFyi(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String nodeName, List<AdHocRouteRecipient> adHocRecipients)
     
    void
    clearFyi(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, List<AdHocRouteRecipient> adHocRecipients)
    clear the fyi request for this document, optinoally providing a list of ad hoc recipients for this document which should be restricted to actions requested of fyi as all other action request types will be discarded
    void
    complete(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, String nodeName, List adHocRecipients)
     
    void
    complete(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, List adHocRecipients)
    Completes document
    org.kuali.rice.kew.api.WorkflowDocument
    createWorkflowDocument(String documentTypeName, Person workflowUser)
    Given a documentTypeName and workflowUser, returns a new workflowDocument from the workflow server.
    void
    disapprove(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation)
    disapprove this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
    String
    getCurrentRouteLevelName(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)
    Gets the current route level name of the workflow document even if document has no active node names.
    String
    getCurrentRouteNodeNames(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)
    Returns the current node names of the document delimited by ", " if there is more than one.
    org.kuali.rice.kew.api.WorkflowDocument
    loadWorkflowDocument(String documentHeaderId, Person workflowUser)
    Given a documentHeaderId and workflowUser, retrieves the workflowDocument associated with that documentHeaderId from the workflow server.
    void
    recall(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, boolean cancel)
    recall this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
    void
    route(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRecipients)
     
    void
    route(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients)
    route this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken, and additionally optionally providing a list of ad hoc recipients for the document
    void
    save(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation)
    This method will first determine if the WorkflowDocument.saveDocument(String) method is valid to be called.
    void
    saveRoutingData(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)
    save the routing data of the document to workflow
    void
    sendWorkflowNotification(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRecipients)
    Sends workflow notification at the specified node to the list of ad hoc recipients.
    void
    sendWorkflowNotification(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRecipients, String notificationLabel)
    Sends workflow notification at the specified node to the list of ad hoc recipients.
    void
    sendWorkflowNotification(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients)
    Sends workflow notification to the list of ad hoc recipients.
    void
    sendWorkflowNotification(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients, String notificationLabel)
    Sends workflow notification to the list of ad hoc recipients.
    void
    superUserApprove(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation)
    super user approve this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
    void
    superUserCancel(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation)
    super user cancel this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
    void
    superUserDisapprove(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation)
    super user disapprove this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
    boolean
    workflowDocumentExists(String documentHeaderId)
     

  • Method Details

    • workflowDocumentExists

      boolean workflowDocumentExists(String documentHeaderId)
      Parameters:
      documentHeaderId -
      Returns:
      true if a workflowDocument exists for the given documentHeaderId

    • createWorkflowDocument

      org.kuali.rice.kew.api.WorkflowDocument createWorkflowDocument(String documentTypeName, Person workflowUser) throws org.kuali.rice.kew.api.exception.WorkflowException
      Given a documentTypeName and workflowUser, returns a new workflowDocument from the workflow server.
      Parameters:
      documentTypeName -
      workflowUser -
      Returns:
      newly-created workflowDocument instance
      Throws:
      IllegalArgumentException - if the given documentTypeName is blank
      IllegalArgumentException - if the given workflowUser is null or contains no id
      org.kuali.rice.kew.api.exception.ResourceUnavailableException
      org.kuali.rice.kew.api.exception.WorkflowException

    • loadWorkflowDocument

      org.kuali.rice.kew.api.WorkflowDocument loadWorkflowDocument(String documentHeaderId, Person workflowUser) throws org.kuali.rice.kew.api.exception.WorkflowException
      Given a documentHeaderId and workflowUser, retrieves the workflowDocument associated with that documentHeaderId from the workflow server.
      Parameters:
      documentHeaderId -
      workflowUser -
      Returns:
      existing workflowDoc
      Throws:
      IllegalArgumentException - if the given documentHeaderId is null
      IllegalArgumentException - if the given workflowUser is null or contains no id
      org.kuali.rice.kew.api.exception.WorkflowException

    • route

      void route(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRecipients) throws org.kuali.rice.kew.api.exception.WorkflowException
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • save

      void save(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation) throws org.kuali.rice.kew.api.exception.WorkflowException
      This method will first determine if the WorkflowDocument.saveDocument(String) method is valid to be called. If so the method will save the document to workflows action list optionally providing an annotation which will show up in the route log for this document corresponding to this action taken. If the WorkflowDocument.saveDocument() method is not valid to be called the system will instead call the method saveRoutingData(WorkflowDocument)
      Parameters:
      workflowDocument -
      annotation -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • saveRoutingData

      void saveRoutingData(org.kuali.rice.kew.api.WorkflowDocument workflowDocument) throws org.kuali.rice.kew.api.exception.WorkflowException
      save the routing data of the document to workflow
      Parameters:
      workflowDocument -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • route

      void route(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients) throws org.kuali.rice.kew.api.exception.WorkflowException
      route this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken, and additionally optionally providing a list of ad hoc recipients for the document
      Parameters:
      workflowDocument -
      annotation -
      adHocRecipients -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • acknowledge

      void acknowledge(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRecipients) throws org.kuali.rice.kew.api.exception.WorkflowException
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • approve

      void approve(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients) throws org.kuali.rice.kew.api.exception.WorkflowException
      approve this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken, and additionally optionally providing a list of ad hoc recipients for the document
      Parameters:
      workflowDocument -
      annotation -
      adHocRecipients -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • approve

      void approve(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRecipients) throws org.kuali.rice.kew.api.exception.WorkflowException
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • superUserApprove

      void superUserApprove(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation) throws org.kuali.rice.kew.api.exception.WorkflowException
      super user approve this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
      Parameters:
      workflowDocument -
      annotation -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • superUserCancel

      void superUserCancel(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation) throws org.kuali.rice.kew.api.exception.WorkflowException
      super user cancel this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
      Parameters:
      workflowDocument -
      annotation -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • superUserDisapprove

      void superUserDisapprove(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation) throws org.kuali.rice.kew.api.exception.WorkflowException
      super user disapprove this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
      Parameters:
      workflowDocument -
      annotation -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • disapprove

      void disapprove(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation) throws org.kuali.rice.kew.api.exception.WorkflowException
      disapprove this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
      Parameters:
      workflowDocument -
      annotation -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • blanketApprove

      void blanketApprove(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRecipients) throws org.kuali.rice.kew.api.exception.WorkflowException
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • cancel

      void cancel(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation) throws org.kuali.rice.kew.api.exception.WorkflowException
      cancel this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
      Parameters:
      workflowDocument -
      annotation -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • acknowledge

      void acknowledge(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients) throws org.kuali.rice.kew.api.exception.WorkflowException
      acknowledge this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken, additionally optionally providing a list of ad hoc recipients for this document which should be restricted to actions requested of acknowledge or fyi as all other action request types will be discarded
      Parameters:
      workflowDocument -
      annotation -
      adHocRecipients -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • blanketApprove

      void blanketApprove(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients) throws org.kuali.rice.kew.api.exception.WorkflowException
      blanket approve this document optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken, and additionally optionally providing a list of ad hoc recipients for this document which should be restricted to actions requested of acknowledge or fyi as all other action request types will be discarded.
      Parameters:
      workflowDocument -
      annotation -
      adHocRecipients -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • clearFyi

      void clearFyi(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, List<AdHocRouteRecipient> adHocRecipients) throws org.kuali.rice.kew.api.exception.WorkflowException
      clear the fyi request for this document, optinoally providing a list of ad hoc recipients for this document which should be restricted to actions requested of fyi as all other action request types will be discarded
      Parameters:
      workflowDocument -
      adHocRecipients -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • getCurrentRouteLevelName

      String getCurrentRouteLevelName(org.kuali.rice.kew.api.WorkflowDocument workflowDocument) throws org.kuali.rice.kew.api.exception.WorkflowException
      Gets the current route level name of the workflow document even if document has no active node names. Allows for getting the node name of a document already in a final status.
      Parameters:
      workflowDocument -
      Returns:
      node name of the current node if only one or list of node names separated by string ", " if more than one current node name
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • sendWorkflowNotification

      void sendWorkflowNotification(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients, String notificationLabel) throws org.kuali.rice.kew.api.exception.WorkflowException
      Sends workflow notification to the list of ad hoc recipients. This method is usually used to notify users of a note that has been added to a document. The notificationLabel parameter is used to give the request a custom label in the user's Action List
      Parameters:
      workflowDocument -
      annotation -
      adHocRecipients -
      notificationLabel -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • sendWorkflowNotification

      void sendWorkflowNotification(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRecipients, String notificationLabel) throws org.kuali.rice.kew.api.exception.WorkflowException
      Sends workflow notification at the specified node to the list of ad hoc recipients. This method is usually used to notify users of a note that has been added to a document. The notificationLabel parameter is used to give the request a custom label in the user's Action List
      Parameters:
      workflowDocument -
      annotation -
      nodeName -
      adHocRecipients -
      notificationLabel -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • clearFyi

      void clearFyi(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String nodeName, List<AdHocRouteRecipient> adHocRecipients) throws org.kuali.rice.kew.api.exception.WorkflowException
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • sendWorkflowNotification

      void sendWorkflowNotification(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients) throws org.kuali.rice.kew.api.exception.WorkflowException
      Sends workflow notification to the list of ad hoc recipients. This method is usually used to notify users of a note that has been added to a document
      Parameters:
      workflowDocument -
      annotation -
      adHocRecipients -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • sendWorkflowNotification

      void sendWorkflowNotification(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, String nodeName, List<AdHocRouteRecipient> adHocRecipients) throws org.kuali.rice.kew.api.exception.WorkflowException
      Sends workflow notification at the specified node to the list of ad hoc recipients. This method is usually used to notify users of a note that has been added to a document
      Parameters:
      workflowDocument -
      annotation -
      nodeName -
      adHocRecipients -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • getCurrentRouteNodeNames

      String getCurrentRouteNodeNames(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)
      Returns the current node names of the document delimited by ", " if there is more than one.

    • complete

      void complete(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, List adHocRecipients) throws org.kuali.rice.kew.api.exception.WorkflowException
      Completes document
      Parameters:
      workflowDocument -
      annotation -
      adHocRecipients -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • recall

      void recall(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, boolean cancel) throws org.kuali.rice.kew.api.exception.WorkflowException
      recall this workflowDocument optionally providing an annotation for this action taken which will show up in the route log for this document corresponding to this action taken
      Parameters:
      workflowDocument -
      annotation -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • complete

      void complete(org.kuali.rice.kew.api.WorkflowDocument workflowDocument, String annotation, String nodeName, List adHocRecipients) throws org.kuali.rice.kew.api.exception.WorkflowException
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException