Package org.kuali.rice.kew.actions

Class CancelAction

java.lang.Object

org.kuali.rice.kew.actions.ActionTakenEvent

org.kuali.rice.kew.actions.CancelAction

public class CancelAction
extends ActionTakenEvent

Cancels a document at the request of a client app.

Author:

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

Field Summary

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	Description
CancelAction(DocumentRouteHeaderValue rh, org.kuali.rice.kim.api.identity.principal.PrincipalContract principal)
CancelAction(DocumentRouteHeaderValue rh, org.kuali.rice.kim.api.identity.principal.PrincipalContract principal, String annotation)

Method Summary

Modifier and Type	Method	Description
boolean	isActionCompatibleRequest(List<ActionRequestValue> requests)
protected void	markDocumentStatus()
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, generateAcknowledgementsToPreviousActionTakers, getActionPerformedCode, getActionRequestService, getActionTakenCode, getDocumentId, getGroupIdsForPrincipal, getPrincipal, getRouteHeader, invokePostProcessor, 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

Constructor Details

CancelAction

public CancelAction(DocumentRouteHeaderValue rh,
 org.kuali.rice.kim.api.identity.principal.PrincipalContract principal)

CancelAction

public CancelAction(DocumentRouteHeaderValue rh,
 org.kuali.rice.kim.api.identity.principal.PrincipalContract principal,
 String annotation)

Method Details

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

isActionCompatibleRequest

public boolean isActionCompatibleRequest(List<ActionRequestValue> requests)

Overrides:

isActionCompatibleRequest in class ActionTakenEvent

markDocumentStatus

protected void markDocumentStatus()
                           throws org.kuali.rice.kew.api.exception.InvalidActionTakenException

Throws:

org.kuali.rice.kew.api.exception.InvalidActionTakenException

recordAction

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

Specified by:

recordAction in class ActionTakenEvent

Throws:

org.kuali.rice.kew.api.exception.InvalidActionTakenException