org.kuali.rice.kew.actionrequest
Class ActionRequestFactory

java.lang.Object
  org.kuali.rice.kew.actionrequest.ActionRequestFactory

public class ActionRequestFactory
extends Object

A factory to aid in creating the ever-so-gnarly ActionRequestValue object.

Author:

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

Constructor Summary

ActionRequestFactory()

ActionRequestFactory(DocumentRouteHeaderValue document)

ActionRequestFactory(DocumentRouteHeaderValue document, RouteNodeInstance routeNode)

Method Summary

ActionRequestValue	addDelegationRequest(ActionRequestValue parentRequest, Recipient recipient, Long responsibilityId, Boolean forceAction, String delegationType, String annotation, Long ruleId)
ActionRequestValue	addDelegationRoleRequest(ActionRequestValue parentRequest, String approvePolicy, RoleRecipient role, Long responsibilityId, Boolean forceAction, String delegationType, String description, Long ruleId)
ActionRequestValue	addRoleRequest(RoleRecipient role, String actionRequested, String approvePolicy, Integer priority, Long responsibilityId, Boolean forceAction, String description, Long ruleId) Creates a root Role Request
void	addRoleResponsibilityRequest(List<ResponsibilityActionInfo> responsibilities, String approvePolicy) Generates an ActionRequest graph for the given KIM Responsibilities.
ActionRequestValue	addRootActionRequest(String actionRequested, Integer priority, Recipient recipient, String description, Long responsibilityId, Boolean forceAction, String approvePolicy, Long ruleId)
ActionRequestValue	createActionRequest(String actionRequested, Integer priority, Recipient recipient, String description, Long responsibilityId, Boolean forceAction, String annotation)
ActionRequestValue	createActionRequest(String actionRequested, Integer priority, Recipient recipient, String description, Long responsibilityId, Boolean forceAction, String approvePolicy, Long ruleId, String annotation)
ActionRequestValue	createActionRequest(String actionRequested, Integer priority, Recipient recipient, String description, Long responsibilityId, Boolean forceAction, String approvePolicy, Long ruleId, String annotation, String requestLabel)
ActionRequestValue	createActionRequest(String actionRequested, Recipient recipient, String description, Boolean forceAction, String annotation) Constructs ActionRequestValue using default priority and 0 as responsibility
ActionRequestValue	createBlankActionRequest()
ActionRequestValue	createNotificationRequest(String actionRequestCode, KimPrincipal principal, String reasonActionCode, KimPrincipal reasonActionUser, String responsibilityDesc)
List<ActionRequestValue>	generateNotifications(List requests, KimPrincipal principal, Recipient delegator, String notificationRequestCode, String actionTakenCode)
protected static ActionRequestService	getActionRequestService()
protected static IdentityHelperService	getIdentityHelperService()
protected static IdentityManagementService	getIdentityManagementService()
List<ActionRequestValue>	getRequestGraphs()
protected static RoleManagementService	getRoleManagementService()
boolean	relatedToRoot(ActionRequestValue request)

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionRequestFactory

public ActionRequestFactory()

ActionRequestFactory

public ActionRequestFactory(DocumentRouteHeaderValue document)

ActionRequestFactory

public ActionRequestFactory(DocumentRouteHeaderValue document,
                            RouteNodeInstance routeNode)

Method Detail

createActionRequest

public ActionRequestValue createActionRequest(String actionRequested,
                                              Recipient recipient,
                                              String description,
                                              Boolean forceAction,
                                              String annotation)

Constructs ActionRequestValue using default priority and 0 as responsibility

Parameters:

actionRequested -

recipient -

description -

forceAction -

annotation -

Returns:

ActionRequestValue

createActionRequest

public ActionRequestValue createActionRequest(String actionRequested,
                                              Integer priority,
                                              Recipient recipient,
                                              String description,
                                              Long responsibilityId,
                                              Boolean forceAction,
                                              String annotation)

createActionRequest

public ActionRequestValue createActionRequest(String actionRequested,
                                              Integer priority,
                                              Recipient recipient,
                                              String description,
                                              Long responsibilityId,
                                              Boolean forceAction,
                                              String approvePolicy,
                                              Long ruleId,
                                              String annotation)

createActionRequest

public ActionRequestValue createActionRequest(String actionRequested,
                                              Integer priority,
                                              Recipient recipient,
                                              String description,
                                              Long responsibilityId,
                                              Boolean forceAction,
                                              String approvePolicy,
                                              Long ruleId,
                                              String annotation,
                                              String requestLabel)

createBlankActionRequest

public ActionRequestValue createBlankActionRequest()

createNotificationRequest

public ActionRequestValue createNotificationRequest(String actionRequestCode,
                                                    KimPrincipal principal,
                                                    String reasonActionCode,
                                                    KimPrincipal reasonActionUser,
                                                    String responsibilityDesc)

generateNotifications

public List<ActionRequestValue> generateNotifications(List requests,
                                                      KimPrincipal principal,
                                                      Recipient delegator,
                                                      String notificationRequestCode,
                                                      String actionTakenCode)

addRoleRequest

public ActionRequestValue addRoleRequest(RoleRecipient role,
                                         String actionRequested,
                                         String approvePolicy,
                                         Integer priority,
                                         Long responsibilityId,
                                         Boolean forceAction,
                                         String description,
                                         Long ruleId)

Creates a root Role Request

Parameters:

role -

actionRequested -

approvePolicy -

priority -

responsibilityId -

forceAction -

description -

ruleId -

Returns:

the created root role request

addRoleResponsibilityRequest

public void addRoleResponsibilityRequest(List<ResponsibilityActionInfo> responsibilities,
                                         String approvePolicy)

Generates an ActionRequest graph for the given KIM Responsibilities. This graph includes any associated delegations.

Parameters:

responsibilities -

approvePolicy -

addDelegationRoleRequest

public ActionRequestValue addDelegationRoleRequest(ActionRequestValue parentRequest,
                                                   String approvePolicy,
                                                   RoleRecipient role,
                                                   Long responsibilityId,
                                                   Boolean forceAction,
                                                   String delegationType,
                                                   String description,
                                                   Long ruleId)

addDelegationRequest

public ActionRequestValue addDelegationRequest(ActionRequestValue parentRequest,
                                               Recipient recipient,
                                               Long responsibilityId,
                                               Boolean forceAction,
                                               String delegationType,
                                               String annotation,
                                               Long ruleId)

addRootActionRequest

public ActionRequestValue addRootActionRequest(String actionRequested,
                                               Integer priority,
                                               Recipient recipient,
                                               String description,
                                               Long responsibilityId,
                                               Boolean forceAction,
                                               String approvePolicy,
                                               Long ruleId)

relatedToRoot

public boolean relatedToRoot(ActionRequestValue request)

getRequestGraphs

public List<ActionRequestValue> getRequestGraphs()

getActionRequestService

protected static ActionRequestService getActionRequestService()

getRoleManagementService

protected static RoleManagementService getRoleManagementService()

Returns:

the roleManagementService

getIdentityHelperService

protected static IdentityHelperService getIdentityHelperService()

Returns:

the identityHelperService

getIdentityManagementService

protected static IdentityManagementService getIdentityManagementService()

Returns:

the identityManagementService