org.kuali.rice.kew.actions
Class SuperUserActionTakenEvent

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

Direct Known Subclasses:

SuperUserActionRequestApproveEvent, SuperUserApproveEvent, SuperUserCancelEvent, SuperUserDisapproveEvent, SuperUserNodeApproveEvent, SuperUserReturnToPreviousNodeAction

public abstract class SuperUserActionTakenEvent
extends ActionTakenEvent

Super class for all super user action takens.

Author:

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

Field Summary

static String	AUTHORIZATION
protected String	superUserAction

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

annotation, routeHeader

Constructor Summary

SuperUserActionTakenEvent(String actionTakenCode, DocumentRouteHeaderValue routeHeader, PrincipalContract principal)

SuperUserActionTakenEvent(String actionTakenCode, DocumentRouteHeaderValue routeHeader, PrincipalContract principal, String annotation, boolean runPostProcessor)

Method Summary

ActionRequestValue	getActionRequest()
protected abstract void	markDocument()
protected void	processActionRequests()
void	recordAction()
void	setActionRequest(ActionRequestValue actionRequest)
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

Field Detail

superUserAction

protected String superUserAction

AUTHORIZATION

public static String AUTHORIZATION

Constructor Detail

SuperUserActionTakenEvent

public SuperUserActionTakenEvent(String actionTakenCode,
                                 DocumentRouteHeaderValue routeHeader,
                                 PrincipalContract principal)

SuperUserActionTakenEvent

public SuperUserActionTakenEvent(String actionTakenCode,
                                 DocumentRouteHeaderValue routeHeader,
                                 PrincipalContract principal,
                                 String annotation,
                                 boolean runPostProcessor)

Method Detail

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

recordAction

public void recordAction()
                  throws InvalidActionTakenException

Specified by:

recordAction in class ActionTakenEvent

Throws:

InvalidActionTakenException

markDocument

protected abstract void markDocument()
                              throws WorkflowException

Throws:

WorkflowException

processActionRequests

protected void processActionRequests()
                              throws InvalidActionTakenException

Throws:

InvalidActionTakenException

getActionRequest

public ActionRequestValue getActionRequest()

setActionRequest

public void setActionRequest(ActionRequestValue actionRequest)