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

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

routeHeader

Constructor Summary

AdHocAction(DocumentRouteHeaderValue routeHeader, org.kuali.rice.kim.api.identity.principal.PrincipalContract principal)

AdHocAction(DocumentRouteHeaderValue routeHeader, org.kuali.rice.kim.api.identity.principal.PrincipalContract principal, String annotation, String actionRequested, String nodeName, Recipient recipient, String responsibilityDesc, Boolean forceAction, String requestLabel)

Method Summary

void	recordAction()
String	validateActionRules() Placeholder for validation rules for each action
String	validateActionRules(List<ActionRequestValue> actionRequests)

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

filterActionRequestsByCode, findDelegatorForActionRequests, getActionPerformedCode, getActionRequestService, getActionTakenCode, getDocumentId, getGroupIdsForPrincipal, getPrincipal, getRouteHeader, 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

Constructor Detail

AdHocAction

public AdHocAction(DocumentRouteHeaderValue routeHeader,
                   org.kuali.rice.kim.api.identity.principal.PrincipalContract principal)

AdHocAction

public AdHocAction(DocumentRouteHeaderValue routeHeader,
                   org.kuali.rice.kim.api.identity.principal.PrincipalContract principal,
                   String annotation,
                   String actionRequested,
                   String nodeName,
                   Recipient recipient,
                   String responsibilityDesc,
                   Boolean forceAction,
                   String requestLabel)

Method Detail

recordAction

public void recordAction()
                  throws org.kuali.rice.kew.exception.InvalidActionTakenException

Specified by:

recordAction in class ActionTakenEvent

Throws:

org.kuali.rice.kew.exception.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