org.kuali.rice.kew.actions
Class MoveDocumentAction

java.lang.Object
  extended by org.kuali.rice.kew.actions.ActionTakenEvent
      extended by 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
protected  org.apache.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
MoveDocumentAction(DocumentRouteHeaderValue routeHeader, PrincipalContract principal)
           
MoveDocumentAction(DocumentRouteHeaderValue routeHeader, PrincipalContract principal, String annotation, MovePoint movePoint)
           
 
Method Summary
 boolean isActionCompatibleRequest(List<ActionRequestValue> requests)
           
 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 Detail

LOG

protected final org.apache.log4j.Logger LOG
Constructor Detail

MoveDocumentAction

public MoveDocumentAction(DocumentRouteHeaderValue routeHeader,
                          PrincipalContract principal)

MoveDocumentAction

public MoveDocumentAction(DocumentRouteHeaderValue routeHeader,
                          PrincipalContract principal,
                          String annotation,
                          MovePoint movePoint)
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

isActionCompatibleRequest

public boolean isActionCompatibleRequest(List<ActionRequestValue> requests)
Overrides:
isActionCompatibleRequest in class ActionTakenEvent

recordAction

public void recordAction()
                  throws InvalidActionTakenException
Specified by:
recordAction in class ActionTakenEvent
Throws:
InvalidActionTakenException


Copyright © 2005-2012 The Kuali Foundation. All Rights Reserved.