org.kuali.rice.kew.actionrequest.service.impl

Class ActionRequestServiceImpl

java.lang.Object

org.kuali.rice.kew.actionrequest.service.impl.ActionRequestServiceImpl

All Implemented Interfaces:

ActionRequestService

public class ActionRequestServiceImpl
extends Object
implements ActionRequestService

Default implementation of the ActionRequestService.

Author:

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

Constructor Summary

Constructors

Constructor and Description
ActionRequestServiceImpl()

Method Summary

Modifier and Type	Method and Description
ActionRequestValue	activateRequest(ActionRequestValue actionRequest)
ActionRequestValue	activateRequest(ActionRequestValue actionRequest, ActivationContext activationContext)
ActionRequestValue	activateRequest(ActionRequestValue actionRequest, boolean simulate)
ActionRequestValue	activateRequestNoNotification(ActionRequestValue actionRequest, ActivationContext activationContext)
List<ActionRequestValue>	activateRequests(List<ActionRequestValue> actionRequests)
List<ActionRequestValue>	activateRequests(List<ActionRequestValue> actionRequests, ActivationContext activationContext)
List<ActionRequestValue>	activateRequests(List<ActionRequestValue> actionRequests, boolean simulate)
protected boolean	deactivateOnActionAlreadyTaken(ActionRequestValue actionRequestToActivate, ActivationContext activationContext)
protected boolean	deactivateOnEmptyGroup(ActionRequestValue actionRequestToActivate, ActivationContext activationContext) Checks if the action request which is being activated has a group with no members.
protected boolean	deactivateOnInactiveGroup(ActionRequestValue actionRequestToActivate, ActivationContext activationContext) Checks if the action request which is being activated is being assigned to an inactive group.
ActionRequestValue	deactivateRequest(ActionTakenValue actionTaken, ActionRequestValue actionRequest)
ActionRequestValue	deactivateRequest(ActionTakenValue actionTaken, ActionRequestValue actionRequest, ActivationContext activationContext)
List<ActionRequestValue>	deactivateRequests(ActionTakenValue actionTaken, List<ActionRequestValue> actionRequests)
List<ActionRequestValue>	deactivateRequests(ActionTakenValue actionTaken, List<ActionRequestValue> actionRequests, ActivationContext activationContext)
List<ActionRequestValue>	deactivateRequests(ActionTakenValue actionTaken, List<ActionRequestValue> actionRequests, boolean simulate)
void	deleteActionRequestGraph(ActionRequestValue actionRequest) Deletes an action request and all of its action items following the graph down through the action request's children.
protected void	deleteActionRequestGraph(ActionRequestValue actionRequest, boolean populateOutbox)
void	deleteActionRequestGraphNoOutbox(ActionRequestValue actionRequest)
boolean	doesPrincipalHaveRequest(String principalId, String documentId) Checks if the given user has any Action Requests on the given document.
List<ActionRequestValue>	filterActionRequestsByCode(List<ActionRequestValue> actionRequests, String principalId, List<String> principalGroupIds, String requestCode) Filters action requests based on if they occur after the given requestCode, and if they relate to the given principal
List<ActionRequestValue>	findActivatedByGroup(String groupId)
List<ActionRequestValue>	findAllActionRequestsByDocumentId(String documentId)
List<ActionRequestValue>	findAllPendingRequests(String documentId) Returns all pending requests for a given routing identity
List<ActionRequestValue>	findAllRootActionRequestsByDocumentId(String documentId)
List<ActionRequestValue>	findAllValidRequests(String principalId, List<ActionRequestValue> actionRequests, String requestCode)
List<ActionRequestValue>	findAllValidRequests(String principalId, String documentId, String requestCode)
ActionRequestValue	findByActionRequestId(String actionRequestId)
List<ActionRequestValue>	findByDocumentIdIgnoreCurrentInd(String documentId)
List<ActionRequestValue>	findByStatusAndDocId(String statusCode, String documentId)
protected List<ActionRequestValue>	findByStatusAndDocumentId(String statusCode, String documentId)
Recipient	findDelegator(List<ActionRequestValue> actionRequests) Returns the highest priority delegator in the list of action requests.
ActionRequestValue	findDelegatorRequest(ActionRequestValue actionRequest)
List<ActionRequestValue>	findPendingByActionRequestedAndDocId(String actionRequestedCd, String documentId)
List<ActionRequestValue>	findPendingByDoc(String documentId)
List<ActionRequestValue>	findPendingByDocRequestCdNodeName(String documentId, String requestCode, String nodeName)
List<ActionRequestValue>	findPendingRootRequestsByDocId(String documentId)
List<ActionRequestValue>	findPendingRootRequestsByDocIdAtRouteNode(String documentId, String nodeInstanceId)
List<ActionRequestValue>	findPendingRootRequestsByDocumentType(String documentTypeId)
List<ActionRequestValue>	findRootRequestsByDocIdAtRouteNode(String documentId, String nodeInstanceId)
ActionRequestDAO	getActionRequestDAO()
ActionRequestValue	getActionRequestForRole(String actionTakenId)
Map<String,String>	getActionsRequested(DocumentRouteHeaderValue routeHeader, String principalId, boolean completeAndApproveTheSame)
protected Map<String,String>	getActionsRequested(String principalId, List<ActionRequestValue> actionRequests, boolean completeAndApproveTheSame) Returns a Map of actions that are requested for the given principalId in the given list of action requests.
DataObjectService	getDataObjectService()
List<ActionRequestValue>	getDelegateRequests(ActionRequestValue actionRequest)
protected Predicate	getPendingCriteria() Returns criteria for selecting "pending" action requests.
List<String>	getPrincipalIdsWithPendingActionRequestByActionRequestedAndDocId(String actionRequestedCd, String documentId) This method gets a list of ids of all principals who have a pending action request for a document.
ActionRequestValue	getRoot(ActionRequestValue actionRequest)
List<ActionRequestValue>	getRootRequests(Collection<ActionRequestValue> actionRequests)
List<ActionRequestValue>	getTopLevelRequests(ActionRequestValue actionRequest) If this is a role request, then this method returns a List of the action request for each recipient within the role.
ActionRequestValue	initializeActionRequestGraph(ActionRequestValue actionRequest, DocumentRouteHeaderValue document, RouteNodeInstance nodeInstance)
ActionRequestValue	saveActionRequest(ActionRequestValue actionRequest)
protected ActionRequestValue	saveActionRequest(ActionRequestValue actionRequest, boolean simulation)
void	setActionRequestDAO(ActionRequestDAO actionRequestDAO)
void	setDataObjectService(DataObjectService dataObjectService)
void	updateActionRequestsForResponsibilityChange(Set<String> responsibilityIds)

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionRequestServiceImpl

public ActionRequestServiceImpl()

Method Detail

findByActionRequestId

public ActionRequestValue findByActionRequestId(String actionRequestId)

Specified by:

findByActionRequestId in interface ActionRequestService

getActionsRequested

public Map<String,String> getActionsRequested(DocumentRouteHeaderValue routeHeader,
                                              String principalId,
                                              boolean completeAndApproveTheSame)

Specified by:

getActionsRequested in interface ActionRequestService

getActionsRequested

protected Map<String,String> getActionsRequested(String principalId,
                                                 List<ActionRequestValue> actionRequests,
                                                 boolean completeAndApproveTheSame)

Returns a Map of actions that are requested for the given principalId in the given list of action requests.

initializeActionRequestGraph

public ActionRequestValue initializeActionRequestGraph(ActionRequestValue actionRequest,
                                                       DocumentRouteHeaderValue document,
                                                       RouteNodeInstance nodeInstance)

Specified by:

initializeActionRequestGraph in interface ActionRequestService

activateRequests

public List<ActionRequestValue> activateRequests(List<ActionRequestValue> actionRequests)

Specified by:

activateRequests in interface ActionRequestService

activateRequests

public List<ActionRequestValue> activateRequests(List<ActionRequestValue> actionRequests,
                                                 boolean simulate)

Specified by:

activateRequests in interface ActionRequestService

activateRequests

public List<ActionRequestValue> activateRequests(List<ActionRequestValue> actionRequests,
                                                 ActivationContext activationContext)

Specified by:

activateRequests in interface ActionRequestService

activateRequest

public ActionRequestValue activateRequest(ActionRequestValue actionRequest)

Specified by:

activateRequest in interface ActionRequestService

activateRequest

public ActionRequestValue activateRequest(ActionRequestValue actionRequest,
                                          boolean simulate)

Specified by:

activateRequest in interface ActionRequestService

activateRequest

public ActionRequestValue activateRequest(ActionRequestValue actionRequest,
                                          ActivationContext activationContext)

Specified by:

activateRequest in interface ActionRequestService

activateRequestNoNotification

public ActionRequestValue activateRequestNoNotification(ActionRequestValue actionRequest,
                                                        ActivationContext activationContext)

Specified by:

activateRequestNoNotification in interface ActionRequestService

deactivateOnActionAlreadyTaken

protected boolean deactivateOnActionAlreadyTaken(ActionRequestValue actionRequestToActivate,
                                                 ActivationContext activationContext)

deactivateOnEmptyGroup

protected boolean deactivateOnEmptyGroup(ActionRequestValue actionRequestToActivate,
                                         ActivationContext activationContext)

Checks if the action request which is being activated has a group with no members. If this is the case then it will immediately initiate de-activation on the request since a group with no members will result in no action items being generated so should be effectively skipped.

deactivateOnInactiveGroup

protected boolean deactivateOnInactiveGroup(ActionRequestValue actionRequestToActivate,
                                            ActivationContext activationContext)

Checks if the action request which is being activated is being assigned to an inactive group. If this is the case and if the FailOnInactiveGroup policy is set to false then it will immediately initiate de-activation on the request

deactivateRequest

public ActionRequestValue deactivateRequest(ActionTakenValue actionTaken,
                                            ActionRequestValue actionRequest)

Specified by:

deactivateRequest in interface ActionRequestService

deactivateRequest

public ActionRequestValue deactivateRequest(ActionTakenValue actionTaken,
                                            ActionRequestValue actionRequest,
                                            ActivationContext activationContext)

Specified by:

deactivateRequest in interface ActionRequestService

deactivateRequests

public List<ActionRequestValue> deactivateRequests(ActionTakenValue actionTaken,
                                                   List<ActionRequestValue> actionRequests)

Specified by:

deactivateRequests in interface ActionRequestService

deactivateRequests

public List<ActionRequestValue> deactivateRequests(ActionTakenValue actionTaken,
                                                   List<ActionRequestValue> actionRequests,
                                                   boolean simulate)

Specified by:

deactivateRequests in interface ActionRequestService

deactivateRequests

public List<ActionRequestValue> deactivateRequests(ActionTakenValue actionTaken,
                                                   List<ActionRequestValue> actionRequests,
                                                   ActivationContext activationContext)

Specified by:

deactivateRequests in interface ActionRequestService

getRootRequests

public List<ActionRequestValue> getRootRequests(Collection<ActionRequestValue> actionRequests)

Specified by:

getRootRequests in interface ActionRequestService

getRoot

public ActionRequestValue getRoot(ActionRequestValue actionRequest)

Specified by:

getRoot in interface ActionRequestService

findAllPendingRequests

public List<ActionRequestValue> findAllPendingRequests(String documentId)

Returns all pending requests for a given routing identity

Specified by:

findAllPendingRequests in interface ActionRequestService

Parameters:

documentId - the id of the document header being routed

Returns:

a List of all pending ActionRequestValues for the document

findAllValidRequests

public List<ActionRequestValue> findAllValidRequests(String principalId,
                                                     String documentId,
                                                     String requestCode)

Specified by:

findAllValidRequests in interface ActionRequestService

findByStatusAndDocumentId

protected List<ActionRequestValue> findByStatusAndDocumentId(String statusCode,
                                                             String documentId)

findAllValidRequests

public List<ActionRequestValue> findAllValidRequests(String principalId,
                                                     List<ActionRequestValue> actionRequests,
                                                     String requestCode)

Specified by:

findAllValidRequests in interface ActionRequestService

filterActionRequestsByCode

public List<ActionRequestValue> filterActionRequestsByCode(List<ActionRequestValue> actionRequests,
                                                           String principalId,
                                                           List<String> principalGroupIds,
                                                           String requestCode)

Filters action requests based on if they occur after the given requestCode, and if they relate to the given principal

Specified by:

filterActionRequestsByCode in interface ActionRequestService

Parameters:

actionRequests - the List of ActionRequestValues to filter

principalId - the id of the principal to find active requests for

principalGroupIds - List of group ids that the principal belongs to

requestCode - the request code for all ActionRequestValues to be after

Returns:

the filtered List of ActionRequestValues

updateActionRequestsForResponsibilityChange

public void updateActionRequestsForResponsibilityChange(Set<String> responsibilityIds)

Specified by:

updateActionRequestsForResponsibilityChange in interface ActionRequestService

deleteActionRequestGraphNoOutbox

public void deleteActionRequestGraphNoOutbox(ActionRequestValue actionRequest)

Specified by:

deleteActionRequestGraphNoOutbox in interface ActionRequestService

deleteActionRequestGraph

public void deleteActionRequestGraph(ActionRequestValue actionRequest)

Deletes an action request and all of its action items following the graph down through the action request's children. This method should be invoked on a top-level action request.

Specified by:

deleteActionRequestGraph in interface ActionRequestService

deleteActionRequestGraph

protected void deleteActionRequestGraph(ActionRequestValue actionRequest,
                                        boolean populateOutbox)

findByDocumentIdIgnoreCurrentInd

public List<ActionRequestValue> findByDocumentIdIgnoreCurrentInd(String documentId)

Specified by:

findByDocumentIdIgnoreCurrentInd in interface ActionRequestService

findAllActionRequestsByDocumentId

public List<ActionRequestValue> findAllActionRequestsByDocumentId(String documentId)

Specified by:

findAllActionRequestsByDocumentId in interface ActionRequestService

findAllRootActionRequestsByDocumentId

public List<ActionRequestValue> findAllRootActionRequestsByDocumentId(String documentId)

Specified by:

findAllRootActionRequestsByDocumentId in interface ActionRequestService

findPendingByActionRequestedAndDocId

public List<ActionRequestValue> findPendingByActionRequestedAndDocId(String actionRequestedCd,
                                                                     String documentId)

Specified by:

findPendingByActionRequestedAndDocId in interface ActionRequestService

getPrincipalIdsWithPendingActionRequestByActionRequestedAndDocId

public List<String> getPrincipalIdsWithPendingActionRequestByActionRequestedAndDocId(String actionRequestedCd,
                                                                                     String documentId)

Description copied from interface: ActionRequestService

This method gets a list of ids of all principals who have a pending action request for a document.

Specified by:

getPrincipalIdsWithPendingActionRequestByActionRequestedAndDocId in interface ActionRequestService

findPendingRootRequestsByDocId

public List<ActionRequestValue> findPendingRootRequestsByDocId(String documentId)

Specified by:

findPendingRootRequestsByDocId in interface ActionRequestService

findPendingRootRequestsByDocIdAtRouteNode

public List<ActionRequestValue> findPendingRootRequestsByDocIdAtRouteNode(String documentId,
                                                                          String nodeInstanceId)

Specified by:

findPendingRootRequestsByDocIdAtRouteNode in interface ActionRequestService

findRootRequestsByDocIdAtRouteNode

public List<ActionRequestValue> findRootRequestsByDocIdAtRouteNode(String documentId,
                                                                   String nodeInstanceId)

Specified by:

findRootRequestsByDocIdAtRouteNode in interface ActionRequestService

findPendingRootRequestsByDocumentType

public List<ActionRequestValue> findPendingRootRequestsByDocumentType(String documentTypeId)

Specified by:

findPendingRootRequestsByDocumentType in interface ActionRequestService

saveActionRequest

public ActionRequestValue saveActionRequest(ActionRequestValue actionRequest)

Specified by:

saveActionRequest in interface ActionRequestService

saveActionRequest

protected ActionRequestValue saveActionRequest(ActionRequestValue actionRequest,
                                               boolean simulation)

findPendingByDoc

public List<ActionRequestValue> findPendingByDoc(String documentId)

Specified by:

findPendingByDoc in interface ActionRequestService

findPendingByDocRequestCdNodeName

public List<ActionRequestValue> findPendingByDocRequestCdNodeName(String documentId,
                                                                  String requestCode,
                                                                  String nodeName)

Specified by:

findPendingByDocRequestCdNodeName in interface ActionRequestService

findActivatedByGroup

public List<ActionRequestValue> findActivatedByGroup(String groupId)

Specified by:

findActivatedByGroup in interface ActionRequestService

findByStatusAndDocId

public List<ActionRequestValue> findByStatusAndDocId(String statusCode,
                                                     String documentId)

Specified by:

findByStatusAndDocId in interface ActionRequestService

findDelegator

public Recipient findDelegator(List<ActionRequestValue> actionRequests)

Description copied from interface: ActionRequestService

Returns the highest priority delegator in the list of action requests.

Specified by:

findDelegator in interface ActionRequestService

findDelegatorRequest

public ActionRequestValue findDelegatorRequest(ActionRequestValue actionRequest)

Specified by:

findDelegatorRequest in interface ActionRequestService

getDelegateRequests

public List<ActionRequestValue> getDelegateRequests(ActionRequestValue actionRequest)

Specified by:

getDelegateRequests in interface ActionRequestService

getTopLevelRequests

public List<ActionRequestValue> getTopLevelRequests(ActionRequestValue actionRequest)

Description copied from interface: ActionRequestService

If this is a role request, then this method returns a List of the action request for each recipient within the role. Otherwise, it will return a List with just the original action request.

Specified by:

getTopLevelRequests in interface ActionRequestService

doesPrincipalHaveRequest

public boolean doesPrincipalHaveRequest(String principalId,
                                        String documentId)

Description copied from interface: ActionRequestService

Checks if the given user has any Action Requests on the given document.

Specified by:

doesPrincipalHaveRequest in interface ActionRequestService

getActionRequestForRole

public ActionRequestValue getActionRequestForRole(String actionTakenId)

Specified by:

getActionRequestForRole in interface ActionRequestService

getPendingCriteria

protected Predicate getPendingCriteria()

Returns criteria for selecting "pending" action requests. A request is pending if it's status is activated or initialized.

Returns:

criteria for selecting pending action requests

getDataObjectService

public DataObjectService getDataObjectService()

setDataObjectService

public void setDataObjectService(DataObjectService dataObjectService)

getActionRequestDAO

public ActionRequestDAO getActionRequestDAO()

setActionRequestDAO

public void setActionRequestDAO(ActionRequestDAO actionRequestDAO)