Package org.kuali.rice.kew.actions

Class RouteDocumentAction

java.lang.Object

org.kuali.rice.kew.actions.ActionTakenEvent

org.kuali.rice.kew.actions.RouteDocumentAction

public class RouteDocumentAction
extends ActionTakenEvent

Action that puts the document in routing.

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

Method Summary

Modifier and Type	Method	Description
String	getActionPerformedCode()	Code of the action performed by the user Method may be overridden is action performed will be different than action taken
void	recordAction()	Record the routing 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, 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 Details

RouteDocumentAction

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

RouteDocumentAction

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

Method Details

getActionPerformedCode

public String getActionPerformedCode()

Description copied from class: ActionTakenEvent

Code of the action performed by the user Method may be overridden is action performed will be different than action taken

Overrides:

getActionPerformedCode in class ActionTakenEvent

Returns:

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

Record the routing action. To route a document, it must be in the proper state. Previous requests and actions have no bearing on the outcome of this action, unless the

Specified by:

recordAction in class ActionTakenEvent

Throws:

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