org.kuali.rice.kew.actions

Class SuperUserApproveEvent

java.lang.Object

org.kuali.rice.kew.actions.ActionTakenEvent

org.kuali.rice.kew.actions.SuperUserApproveEvent

public class SuperUserApproveEvent
extends ActionTakenEvent

Does a super user approve action.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHORIZATION
protected String	superUserAction

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

annotation, DEFAULT_ANNOTATION, DEFAULT_QUEUE_DOCUMENT_AFTER_ACTION, DEFAULT_RUN_POSTPROCESSOR_LOGIC, routeHeader

Constructor Summary

Constructors

Constructor and Description
SuperUserApproveEvent(DocumentRouteHeaderValue routeHeader, org.kuali.rice.kim.api.identity.principal.PrincipalContract principal)
SuperUserApproveEvent(DocumentRouteHeaderValue routeHeader, org.kuali.rice.kim.api.identity.principal.PrincipalContract principal, String annotation, boolean runPostProcessor)

Method Summary

Modifier and Type	Method and Description
protected void	completeAnyOutstandingCompleteApproveRequests(ActionTakenValue actionTaken, boolean sendNotifications)
ActionRequestValue	getActionRequest()
String	getSuperUserAction()
protected void	markDocument()
protected ActionTakenValue	processActionRequests()
protected void	processActionTaken(ActionTakenValue actionTaken) Allows subclasses to perform any post-processing after the action has been taken
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, generateAcknowledgementsToPreviousActionTakers, getActionPerformedCode, getActionRequestService, getActionTakenCode, getDocumentId, getGroupIdsForPrincipal, getPrincipal, getRouteHeader, invokePostProcessor, isActionCompatibleRequest, isActionValid, isPolicySet, isPolicySet, isRunPostProcessorLogic, notifyActionTaken, notifyAfterActionTaken, notifyStatusChange, performAction, queueDocumentProcessing, saveActionTaken, saveActionTaken, saveActionTaken, saveActionTaken, setActionTakenCode, setRouteHeader, updateSearchableAttributesIfPossible

Methods inherited from class java.lang.Object

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

Field Detail

superUserAction

protected final String superUserAction

AUTHORIZATION

public static String AUTHORIZATION

Constructor Detail

SuperUserApproveEvent

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

SuperUserApproveEvent

public SuperUserApproveEvent(DocumentRouteHeaderValue routeHeader,
                             org.kuali.rice.kim.api.identity.principal.PrincipalContract principal,
                             String annotation,
                             boolean runPostProcessor)

Method Detail

validateActionRules

public String validateActionRules()

Description copied from class: ActionTakenEvent

Placeholder for validation rules for each action

Returns:

error message string of specific error message

recordAction

public void recordAction()
                  throws InvalidActionTakenException

Throws:

InvalidActionTakenException

completeAnyOutstandingCompleteApproveRequests

protected void completeAnyOutstandingCompleteApproveRequests(ActionTakenValue actionTaken,
                                                             boolean sendNotifications)
                                                      throws Exception

Throws:

Exception

markDocument

protected void markDocument()
                     throws WorkflowException

Throws:

WorkflowException

validateActionRules

public String validateActionRules(List<ActionRequestValue> actionRequests)

Specified by:

validateActionRules in class ActionTakenEvent

processActionRequests

protected ActionTakenValue processActionRequests()
                                          throws InvalidActionTakenException

Throws:

InvalidActionTakenException

processActionTaken

protected void processActionTaken(ActionTakenValue actionTaken)

Allows subclasses to perform any post-processing after the action has been taken

getActionRequest

public ActionRequestValue getActionRequest()

setActionRequest

public void setActionRequest(ActionRequestValue actionRequest)

getSuperUserAction

public String getSuperUserAction()