Package org.kuali.rice.kew.impl.action

Class WorkflowDocumentActionsServiceImpl

java.lang.Object

org.kuali.rice.kew.impl.action.WorkflowDocumentActionsServiceImpl

All Implemented Interfaces:

WorkflowDocumentActionsService

public class WorkflowDocumentActionsServiceImpl
extends Object
implements WorkflowDocumentActionsService

Reference implementation of the WorkflowDocumentActionsService api.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	WorkflowDocumentActionsServiceImpl.DocumentActionCallback
protected static class	WorkflowDocumentActionsServiceImpl.StandardDocumentActionCallback

Constructor Summary

Constructors

Constructor	Description
WorkflowDocumentActionsServiceImpl()

Method Summary

Modifier and Type	Method	Description
DocumentActionResult	acknowledge(DocumentActionParameters parameters)
DocumentActionResult	adHocToGroup(DocumentActionParameters parameters, AdHocToGroup adHocToGroup)
DocumentActionResult	adHocToGroup(DocumentActionParameters parameters, AdHocToGroup_v2_1_2 adHocToGroup)
DocumentActionResult	adHocToPrincipal(DocumentActionParameters parameters, AdHocToPrincipal adHocToPrincipal)
DocumentActionResult	adHocToPrincipal(DocumentActionParameters parameters, AdHocToPrincipal_v2_1_2 adHocToPrincipal)
DocumentActionResult	approve(DocumentActionParameters parameters)
DocumentActionResult	blanketApprove(DocumentActionParameters parameters)
DocumentActionResult	blanketApproveToNodes(DocumentActionParameters parameters, Set<String> nodeNames)
DocumentActionResult	cancel(DocumentActionParameters parameters)
DocumentActionResult	clearFyi(DocumentActionParameters parameters)
DocumentActionResult	complete(DocumentActionParameters parameters)
protected DocumentActionResult	constructDocumentActionResult(DocumentRouteHeaderValue documentBo, String principalId)
Document	create(String documentTypeName, String initiatorPrincipalId, DocumentUpdate documentUpdate, DocumentContentUpdate documentContentUpdate)
Document	delete(String documentId, String principalId)
RequestedActions	determineRequestedActions(String documentId, String principalId)
protected RequestedActions	determineRequestedActionsInternal(DocumentRouteHeaderValue documentBo, String principalId)
protected boolean	determineValidActionInternal(String actionTypeCode, DocumentRouteHeaderValue documentBo, String principalId)
ValidActions	determineValidActions(String documentId, String principalId)
protected ValidActions	determineValidActionsInternal(DocumentRouteHeaderValue documentBo, String principalId)
DocumentActionResult	disapprove(DocumentActionParameters parameters)
boolean	documentWillHaveAtLeastOneActionRequest(RoutingReportCriteria reportCriteria, List<String> actionRequestedCodes, boolean ignoreCurrentActionRequests)
protected DocumentActionResult	executeActionInternal(DocumentActionParameters parameters, WorkflowDocumentActionsServiceImpl.DocumentActionCallback callback)
DocumentDetail	executeSimulation(RoutingReportCriteria reportCriteria)
List<String>	getPrincipalIdsInRouteLog(String documentId, boolean lookFuture)
protected DocumentRouteHeaderValue	init(DocumentActionParameters parameters)
void	initiateIndexing(String documentId)
boolean	isFinalApprover(String documentId, String principalId)
boolean	isLastApproverAtNode(String documentId, String principalId, String nodeName)
boolean	isUserInRouteLog(String documentId, String principalId, boolean lookFuture)
boolean	isUserInRouteLogWithOptionalFlattening(String documentId, String principalId, boolean lookFuture, boolean flattenNodes)
boolean	isValidAction(String actionTypeCode, String documentId, String principalId)
void	logAnnotation(String documentId, String principalId, String annotation)
DocumentActionResult	move(DocumentActionParameters parameters, MovePoint movePoint)
DocumentActionResult	placeInExceptionRouting(DocumentActionParameters parameters)
DocumentActionResult	recall(DocumentActionParameters parameters, boolean cancel)
DocumentActionResult	releaseGroupAuthority(DocumentActionParameters parameters, String groupId)
void	reResolveRoleByDocTypeName(String documentTypeName, String roleName, String qualifiedRoleNameLabel)
void	reResolveRoleByDocumentId(String documentId, String roleName, String qualifiedRoleNameLabel)
DocumentActionResult	returnToPreviousNode(DocumentActionParameters parameters, ReturnPoint returnPoint)
DocumentActionResult	revokeAdHocRequestById(DocumentActionParameters parameters, String actionRequestId)
DocumentActionResult	revokeAdHocRequests(DocumentActionParameters parameters, AdHocRevoke revoke)
DocumentActionResult	revokeAllAdHocRequests(DocumentActionParameters parameters)
DocumentActionResult	route(DocumentActionParameters parameters)
boolean	routeNodeHasApproverActionRequest(String documentTypeName, String docContent, String nodeName)
DocumentActionResult	save(DocumentActionParameters parameters)
DocumentActionResult	saveDocumentData(DocumentActionParameters parameters)
void	setDocumentTypeService(DocumentTypeService documentTypeService)
DocumentActionResult	superUserBlanketApprove(DocumentActionParameters parameters, boolean executePostProcessor)
DocumentActionResult	superUserCancel(DocumentActionParameters parameters, boolean executePostProcessor)
DocumentActionResult	superUserDisapprove(DocumentActionParameters parameters, boolean executePostProcessor)
DocumentActionResult	superUserNodeApprove(DocumentActionParameters parameters, boolean executePostProcessor, String nodeName)
DocumentActionResult	superUserReturnToPreviousNode(DocumentActionParameters parameters, boolean executePostProcessor, ReturnPoint returnPoint)
DocumentActionResult	superUserTakeRequestedAction(DocumentActionParameters parameters, boolean executePostProcessor, String actionRequestId)
DocumentActionResult	takeGroupAuthority(DocumentActionParameters parameters, String groupId)
List<RemotableAttributeError>	validateWorkflowAttributeDefinition(WorkflowAttributeDefinition definition)

Methods inherited from class java.lang.Object

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

Constructor Details

WorkflowDocumentActionsServiceImpl

public WorkflowDocumentActionsServiceImpl()

Method Details

init

protected DocumentRouteHeaderValue init(DocumentActionParameters parameters)

create

public Document create(String documentTypeName,
 String initiatorPrincipalId,
 DocumentUpdate documentUpdate,
 DocumentContentUpdate documentContentUpdate)
                throws RiceIllegalArgumentException,
IllegalDocumentTypeException,
InvalidActionTakenException

Specified by:

create in interface WorkflowDocumentActionsService

Throws:

RiceIllegalArgumentException

IllegalDocumentTypeException

InvalidActionTakenException

determineValidActions

public ValidActions determineValidActions(String documentId,
 String principalId)

Specified by:

determineValidActions in interface WorkflowDocumentActionsService

determineValidActionsInternal

protected ValidActions determineValidActionsInternal(DocumentRouteHeaderValue documentBo,
 String principalId)

isValidAction

public boolean isValidAction(String actionTypeCode,
 String documentId,
 String principalId)
                      throws RiceIllegalArgumentException

Specified by:

isValidAction in interface WorkflowDocumentActionsService

Throws:

RiceIllegalArgumentException

determineValidActionInternal

protected boolean determineValidActionInternal(String actionTypeCode,
 DocumentRouteHeaderValue documentBo,
 String principalId)

determineRequestedActions

public RequestedActions determineRequestedActions(String documentId,
 String principalId)

Specified by:

determineRequestedActions in interface WorkflowDocumentActionsService

determineRequestedActionsInternal

protected RequestedActions determineRequestedActionsInternal(DocumentRouteHeaderValue documentBo,
 String principalId)

executeSimulation

public DocumentDetail executeSimulation(RoutingReportCriteria reportCriteria)

Specified by:

executeSimulation in interface WorkflowDocumentActionsService

constructDocumentActionResult

protected DocumentActionResult constructDocumentActionResult(DocumentRouteHeaderValue documentBo,
 String principalId)

acknowledge

public DocumentActionResult acknowledge(DocumentActionParameters parameters)

Specified by:

acknowledge in interface WorkflowDocumentActionsService

approve

public DocumentActionResult approve(DocumentActionParameters parameters)

Specified by:

approve in interface WorkflowDocumentActionsService

adHocToPrincipal

public DocumentActionResult adHocToPrincipal(DocumentActionParameters parameters,
 AdHocToPrincipal adHocToPrincipal)

Specified by:

adHocToPrincipal in interface WorkflowDocumentActionsService

adHocToPrincipal

public DocumentActionResult adHocToPrincipal(DocumentActionParameters parameters,
 AdHocToPrincipal_v2_1_2 adHocToPrincipal)

Specified by:

adHocToPrincipal in interface WorkflowDocumentActionsService

adHocToGroup

public DocumentActionResult adHocToGroup(DocumentActionParameters parameters,
 AdHocToGroup adHocToGroup)

Specified by:

adHocToGroup in interface WorkflowDocumentActionsService

adHocToGroup

public DocumentActionResult adHocToGroup(DocumentActionParameters parameters,
 AdHocToGroup_v2_1_2 adHocToGroup)

Specified by:

adHocToGroup in interface WorkflowDocumentActionsService

revokeAdHocRequestById

public DocumentActionResult revokeAdHocRequestById(DocumentActionParameters parameters,
 String actionRequestId)

Specified by:

revokeAdHocRequestById in interface WorkflowDocumentActionsService

revokeAdHocRequests

public DocumentActionResult revokeAdHocRequests(DocumentActionParameters parameters,
 AdHocRevoke revoke)

Specified by:

revokeAdHocRequests in interface WorkflowDocumentActionsService

revokeAllAdHocRequests

public DocumentActionResult revokeAllAdHocRequests(DocumentActionParameters parameters)

Specified by:

revokeAllAdHocRequests in interface WorkflowDocumentActionsService

cancel

public DocumentActionResult cancel(DocumentActionParameters parameters)

Specified by:

cancel in interface WorkflowDocumentActionsService

recall

public DocumentActionResult recall(DocumentActionParameters parameters,
 boolean cancel)

Specified by:

recall in interface WorkflowDocumentActionsService

clearFyi

public DocumentActionResult clearFyi(DocumentActionParameters parameters)

Specified by:

clearFyi in interface WorkflowDocumentActionsService

complete

public DocumentActionResult complete(DocumentActionParameters parameters)

Specified by:

complete in interface WorkflowDocumentActionsService

disapprove

public DocumentActionResult disapprove(DocumentActionParameters parameters)

Specified by:

disapprove in interface WorkflowDocumentActionsService

route

public DocumentActionResult route(DocumentActionParameters parameters)

Specified by:

route in interface WorkflowDocumentActionsService

blanketApprove

public DocumentActionResult blanketApprove(DocumentActionParameters parameters)

Specified by:

blanketApprove in interface WorkflowDocumentActionsService

blanketApproveToNodes

public DocumentActionResult blanketApproveToNodes(DocumentActionParameters parameters,
 Set<String> nodeNames)

Specified by:

blanketApproveToNodes in interface WorkflowDocumentActionsService

returnToPreviousNode

public DocumentActionResult returnToPreviousNode(DocumentActionParameters parameters,
 ReturnPoint returnPoint)

Specified by:

returnToPreviousNode in interface WorkflowDocumentActionsService

move

public DocumentActionResult move(DocumentActionParameters parameters,
 MovePoint movePoint)

Specified by:

move in interface WorkflowDocumentActionsService

takeGroupAuthority

public DocumentActionResult takeGroupAuthority(DocumentActionParameters parameters,
 String groupId)

Specified by:

takeGroupAuthority in interface WorkflowDocumentActionsService

releaseGroupAuthority

public DocumentActionResult releaseGroupAuthority(DocumentActionParameters parameters,
 String groupId)

Specified by:

releaseGroupAuthority in interface WorkflowDocumentActionsService

save

public DocumentActionResult save(DocumentActionParameters parameters)

Specified by:

save in interface WorkflowDocumentActionsService

saveDocumentData

public DocumentActionResult saveDocumentData(DocumentActionParameters parameters)

Specified by:

saveDocumentData in interface WorkflowDocumentActionsService

delete

public Document delete(String documentId,
 String principalId)

Specified by:

delete in interface WorkflowDocumentActionsService

logAnnotation

public void logAnnotation(String documentId,
 String principalId,
 String annotation)

Specified by:

logAnnotation in interface WorkflowDocumentActionsService

initiateIndexing

public void initiateIndexing(String documentId)

Specified by:

initiateIndexing in interface WorkflowDocumentActionsService

superUserBlanketApprove

public DocumentActionResult superUserBlanketApprove(DocumentActionParameters parameters,
 boolean executePostProcessor)

Specified by:

superUserBlanketApprove in interface WorkflowDocumentActionsService

superUserNodeApprove

public DocumentActionResult superUserNodeApprove(DocumentActionParameters parameters,
 boolean executePostProcessor,
 String nodeName)

Specified by:

superUserNodeApprove in interface WorkflowDocumentActionsService

superUserTakeRequestedAction

public DocumentActionResult superUserTakeRequestedAction(DocumentActionParameters parameters,
 boolean executePostProcessor,
 String actionRequestId)

Specified by:

superUserTakeRequestedAction in interface WorkflowDocumentActionsService

superUserDisapprove

public DocumentActionResult superUserDisapprove(DocumentActionParameters parameters,
 boolean executePostProcessor)

Specified by:

superUserDisapprove in interface WorkflowDocumentActionsService

superUserCancel

public DocumentActionResult superUserCancel(DocumentActionParameters parameters,
 boolean executePostProcessor)

Specified by:

superUserCancel in interface WorkflowDocumentActionsService

superUserReturnToPreviousNode

public DocumentActionResult superUserReturnToPreviousNode(DocumentActionParameters parameters,
 boolean executePostProcessor,
 ReturnPoint returnPoint)

Specified by:

superUserReturnToPreviousNode in interface WorkflowDocumentActionsService

placeInExceptionRouting

public DocumentActionResult placeInExceptionRouting(DocumentActionParameters parameters)

Specified by:

placeInExceptionRouting in interface WorkflowDocumentActionsService

documentWillHaveAtLeastOneActionRequest

public boolean documentWillHaveAtLeastOneActionRequest(RoutingReportCriteria reportCriteria,
 List<String> actionRequestedCodes,
 boolean ignoreCurrentActionRequests)

Specified by:

documentWillHaveAtLeastOneActionRequest in interface WorkflowDocumentActionsService

reResolveRoleByDocTypeName

public void reResolveRoleByDocTypeName(String documentTypeName,
 String roleName,
 String qualifiedRoleNameLabel)

Specified by:

reResolveRoleByDocTypeName in interface WorkflowDocumentActionsService

reResolveRoleByDocumentId

public void reResolveRoleByDocumentId(String documentId,
 String roleName,
 String qualifiedRoleNameLabel)

Specified by:

reResolveRoleByDocumentId in interface WorkflowDocumentActionsService

validateWorkflowAttributeDefinition

public List<RemotableAttributeError> validateWorkflowAttributeDefinition(WorkflowAttributeDefinition definition)

Specified by:

validateWorkflowAttributeDefinition in interface WorkflowDocumentActionsService

isFinalApprover

public boolean isFinalApprover(String documentId,
 String principalId)

Specified by:

isFinalApprover in interface WorkflowDocumentActionsService

routeNodeHasApproverActionRequest

public boolean routeNodeHasApproverActionRequest(String documentTypeName,
 String docContent,
 String nodeName)

Specified by:

routeNodeHasApproverActionRequest in interface WorkflowDocumentActionsService

isLastApproverAtNode

public boolean isLastApproverAtNode(String documentId,
 String principalId,
 String nodeName)

Specified by:

isLastApproverAtNode in interface WorkflowDocumentActionsService

isUserInRouteLog

public boolean isUserInRouteLog(String documentId,
 String principalId,
 boolean lookFuture)

Specified by:

isUserInRouteLog in interface WorkflowDocumentActionsService

isUserInRouteLogWithOptionalFlattening

public boolean isUserInRouteLogWithOptionalFlattening(String documentId,
 String principalId,
 boolean lookFuture,
 boolean flattenNodes)

Specified by:

isUserInRouteLogWithOptionalFlattening in interface WorkflowDocumentActionsService

getPrincipalIdsInRouteLog

public List<String> getPrincipalIdsInRouteLog(String documentId,
 boolean lookFuture)

Specified by:

getPrincipalIdsInRouteLog in interface WorkflowDocumentActionsService

setDocumentTypeService

public void setDocumentTypeService(DocumentTypeService documentTypeService)

executeActionInternal

protected DocumentActionResult executeActionInternal(DocumentActionParameters parameters,
 WorkflowDocumentActionsServiceImpl.DocumentActionCallback callback)