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, String responsibilityId, Boolean forceAction, String delegationType, String annotation, String ruleId)
ActionRequestValue	addDelegationRoleRequest(ActionRequestValue parentRequest, String approvePolicy, RoleRecipient role, String responsibilityId, Boolean forceAction, String delegationType, String description, String ruleId)
ActionRequestValue	addRoleRequest(RoleRecipient role, String actionRequested, String approvePolicy, Integer priority, String responsibilityId, Boolean forceAction, String description, String ruleId) Creates a root Role Request
void	addRoleResponsibilityRequest(List<org.kuali.rice.kim.api.responsibility.ResponsibilityAction> responsibilities, String approvePolicy) Generates an ActionRequest graph for the given KIM Responsibilities.
ActionRequestValue	addRootActionRequest(String actionRequested, Integer priority, Recipient recipient, String description, String responsibilityId, Boolean forceAction, String approvePolicy, String ruleId)
ActionRequestValue	createActionRequest(String actionRequested, Integer priority, Recipient recipient, String description, String responsibilityId, Boolean forceAction, String annotation)
ActionRequestValue	createActionRequest(String actionRequested, Integer priority, Recipient recipient, String description, String responsibilityId, Boolean forceAction, String approvePolicy, String ruleId, String annotation)
ActionRequestValue	createActionRequest(String actionRequested, Integer priority, Recipient recipient, String description, String responsibilityId, Boolean forceAction, String approvePolicy, String 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, org.kuali.rice.kim.api.identity.principal.PrincipalContract principal, String reasonActionCode, org.kuali.rice.kim.api.identity.principal.PrincipalContract reasonActionUser, String responsibilityDesc)
List<ActionRequestValue>	generateNotifications(List requests, org.kuali.rice.kim.api.identity.principal.PrincipalContract principal, Recipient delegator, String notificationRequestCode, String actionTakenCode)
protected static ActionRequestService	getActionRequestService()
protected static org.kuali.rice.kim.api.group.GroupService	getGroupService()
protected static IdentityHelperService	getIdentityHelperService()
protected static org.kuali.rice.kim.api.services.IdentityService	getIdentityService()
List<ActionRequestValue>	getRequestGraphs()
protected static org.kuali.rice.kim.api.role.RoleService	getRoleService()
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,
                                              String responsibilityId,
                                              Boolean forceAction,
                                              String annotation)

createActionRequest

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

createActionRequest

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

createBlankActionRequest

public ActionRequestValue createBlankActionRequest()

createNotificationRequest

public ActionRequestValue createNotificationRequest(String actionRequestCode,
                                                    org.kuali.rice.kim.api.identity.principal.PrincipalContract principal,
                                                    String reasonActionCode,
                                                    org.kuali.rice.kim.api.identity.principal.PrincipalContract reasonActionUser,
                                                    String responsibilityDesc)

generateNotifications

public List<ActionRequestValue> generateNotifications(List requests,
                                                      org.kuali.rice.kim.api.identity.principal.PrincipalContract principal,
                                                      Recipient delegator,
                                                      String notificationRequestCode,
                                                      String actionTakenCode)

addRoleRequest

public ActionRequestValue addRoleRequest(RoleRecipient role,
                                         String actionRequested,
                                         String approvePolicy,
                                         Integer priority,
                                         String responsibilityId,
                                         Boolean forceAction,
                                         String description,
                                         String 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<org.kuali.rice.kim.api.responsibility.ResponsibilityAction> 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,
                                                   String responsibilityId,
                                                   Boolean forceAction,
                                                   String delegationType,
                                                   String description,
                                                   String ruleId)

addDelegationRequest

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

addRootActionRequest

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

relatedToRoot

public boolean relatedToRoot(ActionRequestValue request)

getRequestGraphs

public List<ActionRequestValue> getRequestGraphs()

getActionRequestService

protected static ActionRequestService getActionRequestService()

getRoleService

protected static org.kuali.rice.kim.api.role.RoleService getRoleService()

Returns:

the roleService

getIdentityHelperService

protected static IdentityHelperService getIdentityHelperService()

Returns:

the identityHelperService

getIdentityService

protected static org.kuali.rice.kim.api.services.IdentityService getIdentityService()

Returns:

the identityService

getGroupService

protected static org.kuali.rice.kim.api.group.GroupService getGroupService()