org.kuali.rice.kew.actions
Class AcknowledgeAction

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

public class AcknowledgeAction
extends ActionTakenEvent

AcknowledegeAction records the users acknowledgement of a document

The routeheader is first checked to make sure the action is valid for the document. Next the user is checked to make sure he/she has not taken a previous action on this document at the actions responsibility or below. The action is recorded. Any requests related to this user are deactivated.

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

AcknowledgeAction(DocumentRouteHeaderValue rh, PrincipalContract principal)

AcknowledgeAction(DocumentRouteHeaderValue rh, PrincipalContract principal, String annotation)

Method Summary

boolean	isActionCompatibleRequest(List requests)
void	recordAction() Records the Acknowldege action.
String	validateActionRules() Method to check if the Action is currently valid on the given document
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

Constructor Detail

AcknowledgeAction

public AcknowledgeAction(DocumentRouteHeaderValue rh,
                         PrincipalContract principal)

Parameters:

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

principal - User taking the action.

AcknowledgeAction

public AcknowledgeAction(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()

Method to check if the Action is currently valid on the given document

Specified by:

validateActionRules in class ActionTakenEvent

Returns:

returns an error message to give system better identifier for problem

validateActionRules

public String validateActionRules(List<ActionRequestValue> actionRequests)

Specified by:

validateActionRules in class ActionTakenEvent

isActionCompatibleRequest

public boolean isActionCompatibleRequest(List requests)

Overrides:

isActionCompatibleRequest in class ActionTakenEvent

recordAction

public void recordAction()
                  throws InvalidActionTakenException

Records the Acknowldege action. - Checks to make sure the document status allows the action. - Checks that the user has not taken a previous action. - Deactivates the pending requests for this user - Records the action

Specified by:

recordAction in class ActionTakenEvent

Throws:

InvalidActionTakenException

ResourceUnavailableException