org.kuali.rice.kew.postprocessor

Class DefaultPostProcessor

java.lang.Object

org.kuali.rice.kew.postprocessor.DefaultPostProcessor

All Implemented Interfaces:

PostProcessor

Direct Known Subclasses:

EDocLitePostProcessor, RulePostProcessor

public class DefaultPostProcessor
extends Object
implements PostProcessor

A simple default implementation of the PostProcessor which can be used as a superclass for post processor which don't want to implement all the methods on the interface. Simply returns a "true" ProcessDocReport for all events exception for deletion.

Author:

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

Constructor Summary

Constructors

Constructor and Description
DefaultPostProcessor()

Method Summary

Modifier and Type	Method and Description
ProcessDocReport	afterActionTaken(ActionType performed, ActionTakenEvent event) Executed after an action is taken against the document.
ProcessDocReport	afterProcess(AfterProcessEvent event) Executed after processing by the workflow engine has completed.
ProcessDocReport	beforeProcess(BeforeProcessEvent event) Executed prior to processing by the workflow engine.
ProcessDocReport	doActionTaken(ActionTakenEvent event) Executed whenever an action is taken against the document.
ProcessDocReport	doDeleteRouteHeader(DeleteEvent event) Executed whenever a deletion of the document is required.
ProcessDocReport	doRouteLevelChange(DocumentRouteLevelChange levelChangeEvent) Executed whenever the document transitions from one node to another.
ProcessDocReport	doRouteStatusChange(DocumentRouteStatusChange statusChangeEvent) Executed whenever the status of the document changes.
List<String>	getDocumentIdsToLock(DocumentLockingEvent lockingEvent) Executed prior to document locking in the workflow engine.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPostProcessor

public DefaultPostProcessor()

Method Detail

doRouteStatusChange

public ProcessDocReport doRouteStatusChange(DocumentRouteStatusChange statusChangeEvent)
                                     throws Exception

Description copied from interface: PostProcessor

Executed whenever the status of the document changes.

Specified by:

doRouteStatusChange in interface PostProcessor

Returns:

ProcessDocReport indicating if the status change succeeded

Throws:

Exception

doRouteLevelChange

public ProcessDocReport doRouteLevelChange(DocumentRouteLevelChange levelChangeEvent)
                                    throws Exception

Description copied from interface: PostProcessor

Executed whenever the document transitions from one node to another.

Specified by:

doRouteLevelChange in interface PostProcessor

Returns:

ProcessDocReport indicating if the node transition succeeded

Throws:

Exception

doDeleteRouteHeader

public ProcessDocReport doDeleteRouteHeader(DeleteEvent event)
                                     throws Exception

Description copied from interface: PostProcessor

Executed whenever a deletion of the document is required.

Specified by:

doDeleteRouteHeader in interface PostProcessor

Returns:

ProcessDocReport indicating if the deletion should be permitted to occur or not

Throws:

Exception

doActionTaken

public ProcessDocReport doActionTaken(ActionTakenEvent event)
                               throws Exception

Description copied from interface: PostProcessor

Executed whenever an action is taken against the document.

Specified by:

doActionTaken in interface PostProcessor

Returns:

ProcessDocReport indicating whether or not the action should succeed

Throws:

Exception

afterActionTaken

public ProcessDocReport afterActionTaken(ActionType performed,
                                         ActionTakenEvent event)
                                  throws Exception

Description copied from interface: PostProcessor

Executed after an action is taken against the document.

Specified by:

afterActionTaken in interface PostProcessor

Returns:

ProcessDocReport indicating whether or not the action was successful

Throws:

Exception

beforeProcess

public ProcessDocReport beforeProcess(BeforeProcessEvent event)
                               throws Exception

Description copied from interface: PostProcessor

Executed prior to processing by the workflow engine.

Specified by:

beforeProcess in interface PostProcessor

Returns:

ProcessDocReport indicating whether or not the document processing should be allowed to proceed

Throws:

Exception

afterProcess

public ProcessDocReport afterProcess(AfterProcessEvent event)
                              throws Exception

Description copied from interface: PostProcessor

Executed after processing by the workflow engine has completed.

Specified by:

afterProcess in interface PostProcessor

Returns:

ProcessDocReport indicating whether or not the document was successfully processed

Throws:

Exception

getDocumentIdsToLock

public List<String> getDocumentIdsToLock(DocumentLockingEvent lockingEvent)
                                  throws Exception

Description copied from interface: PostProcessor

Executed prior to document locking in the workflow engine. This method returns a List of document ids to lock prior to execution of the document in the workflow engine. If the engine processing is going to result in updates to any other documents, they should be locked at the beginning of the engine processing transaction. This method facilitates that.

Note that, by default, the id of the document that is being processed by the engine is always locked. So there is no need to return that document id in the list of document ids to lock.

Specified by:

getDocumentIdsToLock in interface PostProcessor

Returns:

a List of document ids to lock prior to execution of the workflow engine

Throws:

Exception