org.kuali.rice.krad.workflow.service.impl

Class WorkflowDocumentServiceImpl

java.lang.Object

org.kuali.rice.krad.workflow.service.impl.WorkflowDocumentServiceImpl

All Implemented Interfaces:

WorkflowDocumentService

@Transactional
public class WorkflowDocumentServiceImpl
extends Object
implements WorkflowDocumentService

Implementation of the WorkflowDocumentService, which makes use of Workflow

Author:

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

Constructor Summary

Constructors

Constructor and Description
WorkflowDocumentServiceImpl()

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 workflow document
WorkflowDocument	createWorkflowDocument(String documentTypeName, Person person) 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 documentId, Person user) 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 documentId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowDocumentServiceImpl

public WorkflowDocumentServiceImpl()

Method Detail

workflowDocumentExists

public boolean workflowDocumentExists(String documentId)

Specified by:

workflowDocumentExists in interface WorkflowDocumentService

Returns:

true if a workflowDocument exists for the given documentHeaderId

createWorkflowDocument

public WorkflowDocument createWorkflowDocument(String documentTypeName,
                                               Person person)

Description copied from interface: WorkflowDocumentService

Given a documentTypeName and workflowUser, returns a new workflowDocument from the workflow server.

Specified by:

createWorkflowDocument in interface WorkflowDocumentService

Returns:

newly-created workflowDocument instance

loadWorkflowDocument

public WorkflowDocument loadWorkflowDocument(String documentId,
                                             Person user)

Description copied from interface: WorkflowDocumentService

Given a documentHeaderId and workflowUser, retrieves the workflowDocument associated with that documentHeaderId from the workflow server.

Specified by:

loadWorkflowDocument in interface WorkflowDocumentService

Returns:

existing workflowDoc

acknowledge

public void acknowledge(WorkflowDocument workflowDocument,
                        String annotation,
                        List<AdHocRouteRecipient> adHocRecipients)
                 throws WorkflowException

Description copied from interface: WorkflowDocumentService

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

Specified by:

acknowledge in interface WorkflowDocumentService

Throws:

WorkflowException

approve

public void approve(WorkflowDocument workflowDocument,
                    String annotation,
                    List<AdHocRouteRecipient> adHocRecipients)
             throws WorkflowException

Description copied from interface: WorkflowDocumentService

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

Specified by:

approve in interface WorkflowDocumentService

Throws:

WorkflowException

superUserApprove

public void superUserApprove(WorkflowDocument workflowDocument,
                             String annotation)
                      throws WorkflowException

Description copied from interface: WorkflowDocumentService

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

Specified by:

superUserApprove in interface WorkflowDocumentService

Throws:

WorkflowException

superUserCancel

public void superUserCancel(WorkflowDocument workflowDocument,
                            String annotation)
                     throws WorkflowException

Description copied from interface: WorkflowDocumentService

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

Specified by:

superUserCancel in interface WorkflowDocumentService

Throws:

WorkflowException

superUserDisapprove

public void superUserDisapprove(WorkflowDocument workflowDocument,
                                String annotation)
                         throws WorkflowException

Description copied from interface: WorkflowDocumentService

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

Specified by:

superUserDisapprove in interface WorkflowDocumentService

Throws:

WorkflowException

blanketApprove

public void blanketApprove(WorkflowDocument workflowDocument,
                           String annotation,
                           List<AdHocRouteRecipient> adHocRecipients)
                    throws WorkflowException

Description copied from interface: WorkflowDocumentService

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.

Specified by:

blanketApprove in interface WorkflowDocumentService

Throws:

WorkflowException

cancel

public void cancel(WorkflowDocument workflowDocument,
                   String annotation)
            throws WorkflowException

Description copied from interface: WorkflowDocumentService

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

Specified by:

cancel in interface WorkflowDocumentService

Throws:

WorkflowException

recall

public void recall(WorkflowDocument workflowDocument,
                   String annotation,
                   boolean cancel)
            throws WorkflowException

Description copied from interface: WorkflowDocumentService

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

Specified by:

recall in interface WorkflowDocumentService

Throws:

WorkflowException

clearFyi

public void clearFyi(WorkflowDocument workflowDocument,
                     List<AdHocRouteRecipient> adHocRecipients)
              throws WorkflowException

Description copied from interface: WorkflowDocumentService

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

Specified by:

clearFyi in interface WorkflowDocumentService

Throws:

WorkflowException

sendWorkflowNotification

public void sendWorkflowNotification(WorkflowDocument workflowDocument,
                                     String annotation,
                                     List<AdHocRouteRecipient> adHocRecipients)
                              throws WorkflowException

Description copied from interface: WorkflowDocumentService

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

Specified by:

sendWorkflowNotification in interface WorkflowDocumentService

Throws:

WorkflowException

sendWorkflowNotification

public void sendWorkflowNotification(WorkflowDocument workflowDocument,
                                     String annotation,
                                     List<AdHocRouteRecipient> adHocRecipients,
                                     String notificationLabel)
                              throws WorkflowException

Description copied from interface: WorkflowDocumentService

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

Specified by:

sendWorkflowNotification in interface WorkflowDocumentService

Throws:

WorkflowException

disapprove

public void disapprove(WorkflowDocument workflowDocument,
                       String annotation)
                throws WorkflowException

Description copied from interface: WorkflowDocumentService

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

Specified by:

disapprove in interface WorkflowDocumentService

Throws:

WorkflowException

route

public void route(WorkflowDocument workflowDocument,
                  String annotation,
                  List<AdHocRouteRecipient> adHocRecipients)
           throws WorkflowException

Description copied from interface: WorkflowDocumentService

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

Specified by:

route in interface WorkflowDocumentService

Throws:

WorkflowException

save

public void save(WorkflowDocument workflowDocument,
                 String annotation)
          throws WorkflowException

Description copied from interface: WorkflowDocumentService

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 WorkflowDocumentService.saveRoutingData(WorkflowDocument)

Specified by:

save in interface WorkflowDocumentService

Throws:

WorkflowException

saveRoutingData

public void saveRoutingData(WorkflowDocument workflowDocument)
                     throws WorkflowException

Description copied from interface: WorkflowDocumentService

save the routing data of the document to workflow

Specified by:

saveRoutingData in interface WorkflowDocumentService

Throws:

WorkflowException

getCurrentRouteLevelName

public String getCurrentRouteLevelName(WorkflowDocument workflowDocument)
                                throws WorkflowException

Description copied from interface: WorkflowDocumentService

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.

Specified by:

getCurrentRouteLevelName in interface WorkflowDocumentService

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

getCurrentRouteNodeNames

public String getCurrentRouteNodeNames(WorkflowDocument workflowDocument)

Description copied from interface: WorkflowDocumentService

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

Specified by:

getCurrentRouteNodeNames in interface WorkflowDocumentService

complete

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

Completes workflow document

Specified by:

complete in interface WorkflowDocumentService

Throws:

WorkflowException

See Also:

WorkflowDocumentService.complete(org.kuali.rice.kew.api.WorkflowDocument, String, java.util.List)