org.kuali.rice.kew.actions
Class LogDocumentActionAction

java.lang.Object
  org.kuali.rice.kew.actions.ActionTakenEvent
      org.kuali.rice.kew.actions.LogDocumentActionAction

public class LogDocumentActionAction
extends ActionTakenEvent

Simply records an action taken with an annotation.

Author:

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

Field Summary

Fields inherited from class org.kuali.rice.kew.actions.ActionTakenEvent

annotation, routeHeader

Constructor Summary

LogDocumentActionAction(DocumentRouteHeaderValue rh, PrincipalContract principal)

LogDocumentActionAction(DocumentRouteHeaderValue rh, PrincipalContract principal, String annotation)

Method Summary

void	recordAction() Records the non-routed document 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, getActionPerformedCode, getActionRequestService, getActionTakenCode, getDocumentId, getGroupIdsForPrincipal, getPrincipal, getRouteHeader, isActionCompatibleRequest, isActionValid, isRunPostProcessorLogic, notifyActionTaken, notifyStatusChange, performAction, performDeferredAction, queueDocumentProcessing, saveActionTaken, saveActionTaken, saveActionTaken, saveActionTaken, setActionTakenCode, setQueueDocumentAfterAction, setRouteHeader, updateSearchableAttributesIfPossible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogDocumentActionAction

public LogDocumentActionAction(DocumentRouteHeaderValue rh,
                               PrincipalContract principal)

Parameters:

rh - RouteHeader for the document upon which the action is taken.

principal - User taking the action.

LogDocumentActionAction

public LogDocumentActionAction(DocumentRouteHeaderValue rh,
                               PrincipalContract principal,
                               String annotation)

Parameters:

rh - RouteHeader for the document upon which the action is taken.

principal - User taking the action.

annotation - User comment on the action taken

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

recordAction

public void recordAction()
                  throws InvalidActionTakenException

Records the non-routed document action. - Checks to make sure the document status allows the action. Records the action.

Specified by:

recordAction in class ActionTakenEvent

Throws:

InvalidActionTakenException

validateActionRules

public String validateActionRules(List<ActionRequestValue> actionRequests)

Specified by:

validateActionRules in class ActionTakenEvent