Package org.kuali.rice.kew.actions

Class MoveDocumentAction

java.lang.Object

org.kuali.rice.kew.actions.ActionTakenEvent

org.kuali.rice.kew.actions.MoveDocumentAction

public class MoveDocumentAction
extends ActionTakenEvent

Returns a document to a previous node in the route. Current implementation only supports returning to a node on the main branch of the document.

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.logging.log4j.Logger	LOG

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
MoveDocumentAction(DocumentRouteHeaderValue routeHeader, org.kuali.rice.kim.api.identity.principal.PrincipalContract principal)
MoveDocumentAction(DocumentRouteHeaderValue routeHeader, org.kuali.rice.kim.api.identity.principal.PrincipalContract principal, String annotation, org.kuali.rice.kew.api.action.MovePoint movePoint)

Method Summary

Modifier and Type	Method	Description
boolean	isActionCompatibleRequest(List<ActionRequestValue> requests)
protected void	markDocumentEnroute(DocumentRouteHeaderValue routeHeader)
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

Field Details

LOG

protected final org.apache.logging.log4j.Logger LOG

Constructor Details

MoveDocumentAction

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

MoveDocumentAction

public MoveDocumentAction(DocumentRouteHeaderValue routeHeader,
 org.kuali.rice.kim.api.identity.principal.PrincipalContract principal,
 String annotation,
 org.kuali.rice.kew.api.action.MovePoint movePoint)

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

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

markDocumentEnroute

protected void markDocumentEnroute(DocumentRouteHeaderValue routeHeader)
                            throws org.kuali.rice.kew.api.exception.InvalidActionTakenException

Throws:

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