org.kuali.rice.kew.actions
Class AdHocAction

java.lang.Object
  org.kuali.rice.kew.actions.ActionTakenEvent
      org.kuali.rice.kew.actions.AdHocAction

public class AdHocAction
extends ActionTakenEvent

Responsible for creating adhoc requests that are requested from the client.

Author:

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

Field Summary

private String	actionRequested
private String	annotation
private Boolean	forceAction
private static String	NO_ACTION_TAKEN_CODE AdHoc actions don't actually result in an action being taken...it's a special case that generates other action requests
private String	nodeName
private Recipient	recipient
private String	requestLabel
private String	responsibilityDesc

Fields inherited from class org.kuali.rice.kew.actions.ActionTakenEvent

routeHeader

Constructor Summary

AdHocAction(DocumentRouteHeaderValue routeHeader, KimPrincipal principal)

AdHocAction(DocumentRouteHeaderValue routeHeader, KimPrincipal principal, String annotation, String actionRequested, String nodeName, Recipient recipient, String responsibilityDesc, Boolean forceAction, String requestLabel)

Method Summary

private String	adhocRouteAction(List<RouteNodeInstance> targetNodes, boolean forValidationOnly)
private String	createAdHocRequest(RouteNodeInstance routeNode, boolean forValidationOnly)
void	recordAction()
String	validateActionRules() Placeholder for validation rules for each action
String	validateActionRules(List<ActionRequestValue> actionRequests)
private String	validateActionRulesInternal(List<RouteNodeInstance> targetNodes)

Methods inherited from class org.kuali.rice.kew.actions.ActionTakenEvent

filterActionRequestsByCode, findDelegatorForActionRequests, getActionPerformedCode, getActionRequestService, getActionTakenCode, getGroupIdsForPrincipal, getPrincipal, getRouteHeader, getRouteHeaderId, isActionCompatibleRequest, isActionValid, isRunPostProcessorLogic, notifyActionTaken, notifyStatusChange, performAction, performDeferredAction, queueDocumentProcessing, saveActionTaken, saveActionTaken, saveActionTaken, saveActionTaken, setActionTakenCode, setQueueDocumentAfterAction, setRouteHeader, updateSearchableAttributesIfPossible

Methods inherited from class java.lang.Object

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

Field Detail

NO_ACTION_TAKEN_CODE

private static final String NO_ACTION_TAKEN_CODE

AdHoc actions don't actually result in an action being taken...it's a special case that generates other action requests

actionRequested

private String actionRequested

nodeName

private String nodeName

responsibilityDesc

private String responsibilityDesc

forceAction

private Boolean forceAction

recipient

private Recipient recipient

annotation

private String annotation

requestLabel

private String requestLabel

Constructor Detail

AdHocAction

public AdHocAction(DocumentRouteHeaderValue routeHeader,
                   KimPrincipal principal)

AdHocAction

public AdHocAction(DocumentRouteHeaderValue routeHeader,
                   KimPrincipal principal,
                   String annotation,
                   String actionRequested,
                   String nodeName,
                   Recipient recipient,
                   String responsibilityDesc,
                   Boolean forceAction,
                   String requestLabel)

Method Detail

recordAction

public void recordAction()
                  throws InvalidActionTakenException

Specified by:

recordAction in class ActionTakenEvent

Throws:

InvalidActionTakenException

validateActionRules

public String validateActionRules()

Description copied from class: ActionTakenEvent

Placeholder for validation rules for each action

Specified by:

validateActionRules in class ActionTakenEvent

Returns:

error message string of specific error message

validateActionRules

public String validateActionRules(List<ActionRequestValue> actionRequests)

Specified by:

validateActionRules in class ActionTakenEvent

validateActionRulesInternal

private String validateActionRulesInternal(List<RouteNodeInstance> targetNodes)

adhocRouteAction

private String adhocRouteAction(List<RouteNodeInstance> targetNodes,
                                boolean forValidationOnly)

createAdHocRequest

private String createAdHocRequest(RouteNodeInstance routeNode,
                                  boolean forValidationOnly)