org.kuali.rice.kew.actionrequest.service

Interface ActionRequestService

All Known Implementing Classes:

ActionRequestServiceImpl

public interface ActionRequestService

INTERNAL: Service to handle the building, sorting, saving, activating and deactivating of action request graphs.

These lists are what determine role and delegation behaviors in graphs of action requests. Fetching that is being done is also taking into account the 'weight' of action request codes.

Author:

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

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)
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)
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 entity
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 statusCd, 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 actionRequestedCdCd, 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)
ActionRequestValue	getActionRequestForRole(String actionTakenId)
Map<String,String>	getActionsRequested(DocumentRouteHeaderValue routeHeader, String principalId, boolean completeAndApproveTheSame)
List<ActionRequestValue>	getDelegateRequests(ActionRequestValue actionRequest)
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)
void	updateActionRequestsForResponsibilityChange(Set<String> responsibilityIds)

Method Detail

initializeActionRequestGraph

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

findAllValidRequests

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

findAllValidRequests

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

findPendingByDoc

List<ActionRequestValue> findPendingByDoc(String documentId)

saveActionRequest

ActionRequestValue saveActionRequest(ActionRequestValue actionRequest)

activateRequest

ActionRequestValue activateRequest(ActionRequestValue actionRequest)

activateRequest

ActionRequestValue activateRequest(ActionRequestValue actionRequest,
                                   boolean simulate)

activateRequest

ActionRequestValue activateRequest(ActionRequestValue actionRequest,
                                   ActivationContext activationContext)

activateRequests

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

activateRequests

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

activateRequests

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

activateRequestNoNotification

ActionRequestValue activateRequestNoNotification(ActionRequestValue actionRequest,
                                                 ActivationContext activationContext)

deactivateRequest

ActionRequestValue deactivateRequest(ActionTakenValue actionTaken,
                                     ActionRequestValue actionRequest)

deactivateRequests

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

deactivateRequest

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

deactivateRequests

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

deactivateRequests

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

deleteActionRequestGraph

void deleteActionRequestGraph(ActionRequestValue actionRequest)

deleteActionRequestGraphNoOutbox

void deleteActionRequestGraphNoOutbox(ActionRequestValue actionRequest)

findByActionRequestId

ActionRequestValue findByActionRequestId(String actionRequestId)

findPendingRootRequestsByDocId

List<ActionRequestValue> findPendingRootRequestsByDocId(String documentId)

findPendingRootRequestsByDocumentType

List<ActionRequestValue> findPendingRootRequestsByDocumentType(String documentTypeId)

findAllActionRequestsByDocumentId

List<ActionRequestValue> findAllActionRequestsByDocumentId(String documentId)

findAllRootActionRequestsByDocumentId

List<ActionRequestValue> findAllRootActionRequestsByDocumentId(String documentId)

findPendingByActionRequestedAndDocId

List<ActionRequestValue> findPendingByActionRequestedAndDocId(String actionRequestedCdCd,
                                                              String documentId)

getPrincipalIdsWithPendingActionRequestByActionRequestedAndDocId

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.

findByStatusAndDocId

List<ActionRequestValue> findByStatusAndDocId(String statusCd,
                                              String documentId)

findByDocumentIdIgnoreCurrentInd

List<ActionRequestValue> findByDocumentIdIgnoreCurrentInd(String documentId)

findActivatedByGroup

List<ActionRequestValue> findActivatedByGroup(String groupId)

updateActionRequestsForResponsibilityChange

void updateActionRequestsForResponsibilityChange(Set<String> responsibilityIds)

getRoot

ActionRequestValue getRoot(ActionRequestValue actionRequest)

getRootRequests

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

findPendingByDocRequestCdNodeName

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

findAllPendingRequests

List<ActionRequestValue> findAllPendingRequests(String documentId)

Returns all pending requests for a given routing entity

Parameters:

documentId - the id of the document header being routed

Returns:

a List of all pending ActionRequestValues for the document

filterActionRequestsByCode

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

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

findDelegator

Recipient findDelegator(List<ActionRequestValue> actionRequests)

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

findDelegatorRequest

ActionRequestValue findDelegatorRequest(ActionRequestValue actionRequest)

findPendingRootRequestsByDocIdAtRouteNode

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

findRootRequestsByDocIdAtRouteNode

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

getDelegateRequests

List<ActionRequestValue> getDelegateRequests(ActionRequestValue actionRequest)

getTopLevelRequests

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. Otherwise, it will return a List with just the original action request.

doesPrincipalHaveRequest

boolean doesPrincipalHaveRequest(String principalId,
                                 String documentId)

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

getActionsRequested

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

getActionRequestForRole

ActionRequestValue getActionRequestForRole(String actionTakenId)