org.kuali.rice.krad.workflow.postprocessor

Class KualiPostProcessor

java.lang.Object

org.kuali.rice.krad.workflow.postprocessor.KualiPostProcessor

All Implemented Interfaces:

PostProcessor

public class KualiPostProcessor
extends Object
implements PostProcessor

This class is the public entry point by which workflow communicates status changes, level changes, and other useful changes. Note that this class delegates all of these activities to the PostProcessorService, which does the actual work. This is done to ensure proper transaction scoping, and to resolve some issues present otherwise. Because of this, its important to understand that a transaction will be started at the PostProcessorService method call, so any work that needs to be done within the same transaction needs to happen inside that service implementation, rather than in here.

Constructor Summary

Constructors

Constructor and Description
KualiPostProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
ProcessDocReport	afterProcess(AfterProcessEvent afterProcessEvent) Executed after processing by the workflow engine has completed.
ProcessDocReport	beforeProcess(BeforeProcessEvent beforeProcessEvent) 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 documentLockingEvent) 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

KualiPostProcessor

public KualiPostProcessor()

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

See Also:

PostProcessor.doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange)

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

See Also:

PostProcessor.doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent)

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

See Also:

PostProcessor.doDeleteRouteHeader(org.kuali.rice.kew.framework.postprocessor.DeleteEvent)

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

See Also:

PostProcessor.doRouteLevelChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange)

beforeProcess

public ProcessDocReport beforeProcess(BeforeProcessEvent beforeProcessEvent)
                               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

See Also:

PostProcessor.beforeProcess(org.kuali.rice.kew.framework.postprocessor.BeforeProcessEvent)

afterProcess

public ProcessDocReport afterProcess(AfterProcessEvent afterProcessEvent)
                              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

See Also:

PostProcessor.afterProcess(org.kuali.rice.kew.framework.postprocessor.AfterProcessEvent)

getDocumentIdsToLock

public List<String> getDocumentIdsToLock(DocumentLockingEvent documentLockingEvent)
                                  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

See Also:

PostProcessor.getDocumentIdsToLock(org.kuali.rice.kew.framework.postprocessor.DocumentLockingEvent)