Package org.kuali.rice.kew.routeheader.service

Interface WorkflowDocumentService

All Known Implementing Classes:

WorkflowDocumentServiceImpl

public interface WorkflowDocumentService

Service for initiating actions against documents. Uses from the service endpoint for the client API.

Author:

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

See Also:

• WorkflowDocumentActionsService
• ActionTakenEvent

Method Summary

Modifier and Type	Method	Description
DocumentRouteHeaderValue	acknowledgeDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation)
DocumentRouteHeaderValue	adHocRouteDocumentToGroup(String principalId, DocumentRouteHeaderValue routeHeader, String actionRequested, String routeMethodName, Integer priority, String annotation, String groupId, String responsibilityDesc, Boolean forceAction, String requestLabel)
DocumentRouteHeaderValue	adHocRouteDocumentToPrincipal(String principalId, DocumentRouteHeaderValue routeHeader, String actionRequested, String routeMethodName, Integer priority, String annotation, String targetPrincipalId, String responsibilityDesc, Boolean forceAction, String requestLabel)
DocumentRouteHeaderValue	approveDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation)
DocumentRouteHeaderValue	blanketApproval(String principalId, DocumentRouteHeaderValue routeHeader, String annotation, Integer routeLevel)	Deprecated. use blanketApproval which takes a Set of nodeNames instead.
DocumentRouteHeaderValue	blanketApproval(String principalId, DocumentRouteHeaderValue routeHeader, String annotation, Set nodeNames)
DocumentRouteHeaderValue	cancelDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation)
DocumentRouteHeaderValue	clearFYIDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation)
DocumentRouteHeaderValue	completeDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation)
DocumentRouteHeaderValue	createDocument(String principalId, DocumentRouteHeaderValue routeHeader)
void	deleteDocument(String principalId, DocumentRouteHeaderValue routeHeader)
DocumentRouteHeaderValue	disapproveDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation)
void	logDocumentAction(String principalId, DocumentRouteHeaderValue routeHeader, String annotation)
DocumentRouteHeaderValue	moveDocument(String principalId, DocumentRouteHeaderValue routeHeader, MovePoint movePoint, String annotation)
DocumentRouteHeaderValue	placeInExceptionRouting(String principalId, DocumentRouteHeaderValue routeHeader, String annotation)
DocumentRouteHeaderValue	recallDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation, boolean cancel)	TODO: docs
DocumentRouteHeaderValue	releaseGroupAuthority(String principalId, DocumentRouteHeaderValue routeHeader, String groupId, String annotation)
DocumentRouteHeaderValue	returnDocumentToPreviousNode(String principalId, DocumentRouteHeaderValue routeHeader, String destinationNodeName, String annotation)
DocumentRouteHeaderValue	returnDocumentToPreviousRouteLevel(String principalId, DocumentRouteHeaderValue routeHeader, Integer destRouteLevel, String annotation)	Deprecated. use returnDocumentToPreviousNode instead
DocumentRouteHeaderValue	revokeAdHocRequests(String principalId, DocumentRouteHeaderValue document, String actionRequestId, String annotation)
DocumentRouteHeaderValue	revokeAdHocRequests(String principalId, DocumentRouteHeaderValue document, AdHocRevoke revoke, String annotation)
DocumentRouteHeaderValue	routeDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation)
DocumentRouteHeaderValue	saveDocument(String principalId, DocumentRouteHeaderValue routeHeader, String annotation)
DocumentRouteHeaderValue	saveRoutingData(String principalId, DocumentRouteHeaderValue routeHeader)
DocumentRouteHeaderValue	superUserActionRequestApproveAction(String principalId, String documentId, String actionRequestId, String annotation, boolean runPostProcessor)
DocumentRouteHeaderValue	superUserActionRequestApproveAction(String principalId, DocumentRouteHeaderValue routeHeader, String actionRequestId, String annotation, boolean runPostProcessor)
DocumentRouteHeaderValue	superUserApprove(String principalId, DocumentRouteHeaderValue routeHeader, String annotation, boolean runPostProcessor)
DocumentRouteHeaderValue	superUserCancelAction(String principalId, DocumentRouteHeaderValue routeHeader, String annotation, boolean runPostProcessor)
DocumentRouteHeaderValue	superUserDisapproveAction(String principalId, DocumentRouteHeaderValue routeHeader, String annotation, boolean runPostProcessor)
DocumentRouteHeaderValue	superUserNodeApproveAction(String principalId, String documentId, String nodeName, String annotation, boolean runPostProcessor)
DocumentRouteHeaderValue	superUserNodeApproveAction(String principalId, DocumentRouteHeaderValue routeHeader, String nodeName, String annotation, boolean runPostProcessor)
DocumentRouteHeaderValue	superUserReturnDocumentToPreviousNode(String principalId, String documentId, String nodeName, String annotation, boolean runPostProcessor)
DocumentRouteHeaderValue	superUserReturnDocumentToPreviousNode(String principalId, DocumentRouteHeaderValue routeHeader, String nodeName, String annotation, boolean runPostProcessor)
DocumentRouteHeaderValue	takeGroupAuthority(String principalId, DocumentRouteHeaderValue routeHeader, String groupId, String annotation)
void	takeMassActions(String principalId, List<ActionInvocation> actionInvocations)	Invokes a List of actions at once.

Method Details

acknowledgeDocument

DocumentRouteHeaderValue acknowledgeDocument(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String annotation)
                                      throws InvalidActionTakenException

Throws:

InvalidActionTakenException

approveDocument

DocumentRouteHeaderValue approveDocument(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String annotation)
                                  throws InvalidActionTakenException

Throws:

InvalidActionTakenException

adHocRouteDocumentToPrincipal

DocumentRouteHeaderValue adHocRouteDocumentToPrincipal(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String actionRequested,
 String routeMethodName,
 Integer priority,
 String annotation,
 String targetPrincipalId,
 String responsibilityDesc,
 Boolean forceAction,
 String requestLabel)
                                                throws WorkflowException

Throws:

WorkflowException

adHocRouteDocumentToGroup

DocumentRouteHeaderValue adHocRouteDocumentToGroup(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String actionRequested,
 String routeMethodName,
 Integer priority,
 String annotation,
 String groupId,
 String responsibilityDesc,
 Boolean forceAction,
 String requestLabel)
                                            throws WorkflowException

Throws:

WorkflowException

cancelDocument

DocumentRouteHeaderValue cancelDocument(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String annotation)
                                 throws InvalidActionTakenException

Throws:

InvalidActionTakenException

clearFYIDocument

DocumentRouteHeaderValue clearFYIDocument(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String annotation)
                                   throws InvalidActionTakenException

Throws:

InvalidActionTakenException

completeDocument

DocumentRouteHeaderValue completeDocument(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String annotation)
                                   throws InvalidActionTakenException

Throws:

InvalidActionTakenException

createDocument

DocumentRouteHeaderValue createDocument(String principalId,
 DocumentRouteHeaderValue routeHeader)
                                 throws WorkflowException

Throws:

WorkflowException

disapproveDocument

DocumentRouteHeaderValue disapproveDocument(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String annotation)
                                     throws InvalidActionTakenException

Throws:

InvalidActionTakenException

routeDocument

DocumentRouteHeaderValue routeDocument(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String annotation)
                                throws WorkflowException,
InvalidActionTakenException

Throws:

WorkflowException

InvalidActionTakenException

saveRoutingData

DocumentRouteHeaderValue saveRoutingData(String principalId,
 DocumentRouteHeaderValue routeHeader)

saveDocument

DocumentRouteHeaderValue saveDocument(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String annotation)
                               throws InvalidActionTakenException

Throws:

InvalidActionTakenException

deleteDocument

void deleteDocument(String principalId,
 DocumentRouteHeaderValue routeHeader)
             throws WorkflowException

Throws:

WorkflowException

logDocumentAction

void logDocumentAction(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String annotation)
                throws InvalidActionTakenException

Throws:

InvalidActionTakenException

superUserActionRequestApproveAction

DocumentRouteHeaderValue superUserActionRequestApproveAction(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String actionRequestId,
 String annotation,
 boolean runPostProcessor)
                                                      throws InvalidActionTakenException

Throws:

InvalidActionTakenException

superUserActionRequestApproveAction

DocumentRouteHeaderValue superUserActionRequestApproveAction(String principalId,
 String documentId,
 String actionRequestId,
 String annotation,
 boolean runPostProcessor)
                                                      throws InvalidActionTakenException

Throws:

InvalidActionTakenException

superUserApprove

DocumentRouteHeaderValue superUserApprove(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String annotation,
 boolean runPostProcessor)
                                   throws InvalidActionTakenException

Throws:

InvalidActionTakenException

superUserCancelAction

DocumentRouteHeaderValue superUserCancelAction(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String annotation,
 boolean runPostProcessor)
                                        throws InvalidActionTakenException

Throws:

InvalidActionTakenException

superUserDisapproveAction

DocumentRouteHeaderValue superUserDisapproveAction(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String annotation,
 boolean runPostProcessor)
                                            throws InvalidActionTakenException

Throws:

InvalidActionTakenException

placeInExceptionRouting

DocumentRouteHeaderValue placeInExceptionRouting(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String annotation)
                                          throws InvalidActionTakenException

Throws:

InvalidActionTakenException

blanketApproval

DocumentRouteHeaderValue blanketApproval(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String annotation,
 Set nodeNames)
                                  throws InvalidActionTakenException

Throws:

InvalidActionTakenException

Since:

2.1

returnDocumentToPreviousNode

DocumentRouteHeaderValue returnDocumentToPreviousNode(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String destinationNodeName,
 String annotation)
                                               throws InvalidActionTakenException

Throws:

InvalidActionTakenException

Since:

2.1

superUserReturnDocumentToPreviousNode

DocumentRouteHeaderValue superUserReturnDocumentToPreviousNode(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String nodeName,
 String annotation,
 boolean runPostProcessor)
                                                        throws InvalidActionTakenException

Throws:

InvalidActionTakenException

Since:

2.1

takeGroupAuthority

DocumentRouteHeaderValue takeGroupAuthority(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String groupId,
 String annotation)
                                     throws InvalidActionTakenException

Throws:

InvalidActionTakenException

Since:

2.1

releaseGroupAuthority

DocumentRouteHeaderValue releaseGroupAuthority(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String groupId,
 String annotation)
                                        throws InvalidActionTakenException

Throws:

InvalidActionTakenException

Since:

2.1

superUserNodeApproveAction

DocumentRouteHeaderValue superUserNodeApproveAction(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String nodeName,
 String annotation,
 boolean runPostProcessor)
                                             throws InvalidActionTakenException

Throws:

InvalidActionTakenException

Since:

2.1

moveDocument

DocumentRouteHeaderValue moveDocument(String principalId,
 DocumentRouteHeaderValue routeHeader,
 MovePoint movePoint,
 String annotation)
                               throws InvalidActionTakenException

Throws:

InvalidActionTakenException

Since:

2.1

recallDocument

DocumentRouteHeaderValue recallDocument(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String annotation,
 boolean cancel)
                                 throws InvalidActionTakenException

TODO: docs

Throws:

InvalidActionTakenException

Since:

2.1

takeMassActions

void takeMassActions(String principalId,
 List<ActionInvocation> actionInvocations)

Invokes a List of actions at once. This method will remove the approriate action items from the user's action list and then schedule the actual processing of the actions.

Since:

2.2

superUserReturnDocumentToPreviousNode

DocumentRouteHeaderValue superUserReturnDocumentToPreviousNode(String principalId,
 String documentId,
 String nodeName,
 String annotation,
 boolean runPostProcessor)
                                                        throws InvalidActionTakenException

Throws:

InvalidActionTakenException

Since:

2.2

superUserNodeApproveAction

DocumentRouteHeaderValue superUserNodeApproveAction(String principalId,
 String documentId,
 String nodeName,
 String annotation,
 boolean runPostProcessor)
                                             throws InvalidActionTakenException

Throws:

InvalidActionTakenException

Since:

2.2.7

revokeAdHocRequests

DocumentRouteHeaderValue revokeAdHocRequests(String principalId,
 DocumentRouteHeaderValue document,
 AdHocRevoke revoke,
 String annotation)
                                      throws InvalidActionTakenException

Throws:

InvalidActionTakenException

Since:

2.2.2

revokeAdHocRequests

DocumentRouteHeaderValue revokeAdHocRequests(String principalId,
 DocumentRouteHeaderValue document,
 String actionRequestId,
 String annotation)
                                      throws InvalidActionTakenException

Throws:

InvalidActionTakenException

blanketApproval

@Deprecated
DocumentRouteHeaderValue blanketApproval(String principalId,
 DocumentRouteHeaderValue routeHeader,
 String annotation,
 Integer routeLevel)
                                  throws InvalidActionTakenException

Deprecated.

use blanketApproval which takes a Set of nodeNames instead.

Throws:

InvalidActionTakenException

returnDocumentToPreviousRouteLevel

@Deprecated
DocumentRouteHeaderValue returnDocumentToPreviousRouteLevel(String principalId,
 DocumentRouteHeaderValue routeHeader,
 Integer destRouteLevel,
 String annotation)
                                                     throws InvalidActionTakenException

Deprecated.

use returnDocumentToPreviousNode instead

Throws:

InvalidActionTakenException