org.kuali.rice.krad.workflow.service

Interface WorkflowDocumentService

All Known Implementing Classes:

WorkflowDocumentServiceImpl

public interface WorkflowDocumentService

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

Method Summary

Modifier and Type	Method and Description
void	acknowledge(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(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(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(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(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(WorkflowDocument workflowDocument, String annotation, List adHocRecipients) Completes document
WorkflowDocument	createWorkflowDocument(String documentTypeName, Person workflowUser) Given a documentTypeName and workflowUser, returns a new workflowDocument from the workflow server.
void	disapprove(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(WorkflowDocument workflowDocument) Gets the current route level name of the workflow document even if document has no active node names.
String	getCurrentRouteNodeNames(WorkflowDocument workflowDocument) Returns the current node names of the document delimited by ", " if there is more than one.
WorkflowDocument	loadWorkflowDocument(String documentHeaderId, Person workflowUser) Given a documentHeaderId and workflowUser, retrieves the workflowDocument associated with that documentHeaderId from the workflow server.
void	recall(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(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(WorkflowDocument workflowDocument, String annotation) This method will first determine if the WorkflowDocument.saveDocument(String) method is valid to be called.
void	saveRoutingData(WorkflowDocument workflowDocument) save the routing data of the document to workflow
void	sendWorkflowNotification(WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients) Sends workflow notification to the list of ad hoc recipients.
void	sendWorkflowNotification(WorkflowDocument workflowDocument, String annotation, List<AdHocRouteRecipient> adHocRecipients, String notificationLabel) Sends workflow notification to the list of ad hoc recipients.
void	superUserApprove(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(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(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 Detail

workflowDocumentExists

boolean workflowDocumentExists(String documentHeaderId)

Parameters:

documentHeaderId -

Returns:

true if a workflowDocument exists for the given documentHeaderId

createWorkflowDocument

WorkflowDocument createWorkflowDocument(String documentTypeName,
                                        Person workflowUser)
                                 throws 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

ResourceUnavailableException

WorkflowException

loadWorkflowDocument

WorkflowDocument loadWorkflowDocument(String documentHeaderId,
                                      Person workflowUser)
                               throws 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

WorkflowException

save

void save(WorkflowDocument workflowDocument,
          String annotation)
   throws 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:

WorkflowException

saveRoutingData

void saveRoutingData(WorkflowDocument workflowDocument)
              throws WorkflowException

save the routing data of the document to workflow

Parameters:

workflowDocument -

Throws:

WorkflowException

route

void route(WorkflowDocument workflowDocument,
           String annotation,
           List<AdHocRouteRecipient> adHocRecipients)
    throws 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:

WorkflowException

approve

void approve(WorkflowDocument workflowDocument,
             String annotation,
             List<AdHocRouteRecipient> adHocRecipients)
      throws 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:

WorkflowException

superUserApprove

void superUserApprove(WorkflowDocument workflowDocument,
                      String annotation)
               throws 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:

WorkflowException

superUserCancel

void superUserCancel(WorkflowDocument workflowDocument,
                     String annotation)
              throws 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:

WorkflowException

superUserDisapprove

void superUserDisapprove(WorkflowDocument workflowDocument,
                         String annotation)
                  throws 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:

WorkflowException

disapprove

void disapprove(WorkflowDocument workflowDocument,
                String annotation)
         throws 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:

WorkflowException

cancel

void cancel(WorkflowDocument workflowDocument,
            String annotation)
     throws 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:

WorkflowException

acknowledge

void acknowledge(WorkflowDocument workflowDocument,
                 String annotation,
                 List<AdHocRouteRecipient> adHocRecipients)
          throws 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:

WorkflowException

blanketApprove

void blanketApprove(WorkflowDocument workflowDocument,
                    String annotation,
                    List<AdHocRouteRecipient> adHocRecipients)
             throws 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:

WorkflowException

clearFyi

void clearFyi(WorkflowDocument workflowDocument,
              List<AdHocRouteRecipient> adHocRecipients)
       throws 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:

WorkflowException

getCurrentRouteLevelName

String getCurrentRouteLevelName(WorkflowDocument workflowDocument)
                         throws 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:

WorkflowException

sendWorkflowNotification

void sendWorkflowNotification(WorkflowDocument workflowDocument,
                              String annotation,
                              List<AdHocRouteRecipient> adHocRecipients,
                              String notificationLabel)
                       throws 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:

WorkflowException

sendWorkflowNotification

void sendWorkflowNotification(WorkflowDocument workflowDocument,
                              String annotation,
                              List<AdHocRouteRecipient> adHocRecipients)
                       throws 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:

WorkflowException

getCurrentRouteNodeNames

String getCurrentRouteNodeNames(WorkflowDocument workflowDocument)

Returns the current node names of the document delimited by ", " if there is more than one.

complete

void complete(WorkflowDocument workflowDocument,
              String annotation,
              List adHocRecipients)
       throws WorkflowException

Completes document

Parameters:

workflowDocument -

annotation -

adHocRecipients -

Throws:

WorkflowException

recall

void recall(WorkflowDocument workflowDocument,
            String annotation,
            boolean cancel)
     throws 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:

WorkflowException