org.kuali.rice.kew.actions
Class SaveActionEvent

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

public class SaveActionEvent
extends ActionTakenEvent

Saves a document. Puts the document in the persons action list that saved the document. This can currently only be done by the initiator of the document.

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

SaveActionEvent(DocumentRouteHeaderValue routeHeader, PrincipalContract principal)

SaveActionEvent(DocumentRouteHeaderValue routeHeader, PrincipalContract principal, String annotation)

Method Summary

protected ActionRequestValue	generateSaveRequest()
void	recordAction()
String	validateActionRules() Placeholder for validation rules for each action
String	validateActionRules(List<ActionRequestValue> actionRequests) This overridden method ...

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

SaveActionEvent

public SaveActionEvent(DocumentRouteHeaderValue routeHeader,
                       PrincipalContract principal)

SaveActionEvent

public SaveActionEvent(DocumentRouteHeaderValue routeHeader,
                       PrincipalContract principal,
                       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)

This overridden method ...

Specified by:

validateActionRules in class ActionTakenEvent

See Also:

ActionTakenEvent.validateActionRules(java.util.List)

recordAction

public void recordAction()
                  throws InvalidActionTakenException

Specified by:

recordAction in class ActionTakenEvent

Throws:

InvalidActionTakenException

generateSaveRequest

protected ActionRequestValue generateSaveRequest()