org.kuali.rice.kew.actions

Class RevokeAdHocAction

java.lang.Object

org.kuali.rice.kew.actions.ActionTakenEvent

org.kuali.rice.kew.actions.RevokeAdHocAction

public class RevokeAdHocAction
extends ActionTakenEvent

The RevokeAdHocApprove revokes the specified AdHoc requests.

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 and Description
RevokeAdHocAction(DocumentRouteHeaderValue routeHeader, org.kuali.rice.kim.api.identity.principal.PrincipalContract principal)
RevokeAdHocAction(DocumentRouteHeaderValue routeHeader, org.kuali.rice.kim.api.identity.principal.PrincipalContract principal, AdHocRevoke revoke, String annotation)
RevokeAdHocAction(DocumentRouteHeaderValue routeHeader, org.kuali.rice.kim.api.identity.principal.PrincipalContract principal, String actionRequestId, String annotation)

Method Summary

Modifier and Type	Method and Description
protected boolean	matchesActionRequest(AdHocRevoke adHocRevokeCommand, ActionRequestValue actionRequest) Determines if the given action request is an ad hoc request which matches this set of criteria.
void	recordAction() Records the approve action.
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

Constructor Detail

RevokeAdHocAction

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

RevokeAdHocAction

public RevokeAdHocAction(DocumentRouteHeaderValue routeHeader,
                         org.kuali.rice.kim.api.identity.principal.PrincipalContract principal,
                         String actionRequestId,
                         String annotation)

RevokeAdHocAction

public RevokeAdHocAction(DocumentRouteHeaderValue routeHeader,
                         org.kuali.rice.kim.api.identity.principal.PrincipalContract principal,
                         AdHocRevoke revoke,
                         String annotation)

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

Records the approve action. - Checks to make sure the document status allows the action. - Checks that the user has not taken a previous action. - Deactivates the pending requests for this user - Records the action

Specified by:

recordAction in class ActionTakenEvent

Throws:

InvalidActionTakenException

matchesActionRequest

protected boolean matchesActionRequest(AdHocRevoke adHocRevokeCommand,
                                       ActionRequestValue actionRequest)

Determines if the given action request is an ad hoc request which matches this set of criteria.