org.kuali.rice.kew.postprocessor
Interface PostProcessorRemote

All Known Subinterfaces:

PostProcessorService

All Known Implementing Classes:

DefaultPostProcessorRemote, EDocLiteDatabasePostProcessor, EDocLitePostProcessor, KualiPostProcessor, NotificationPostProcessor, NotificationSenderFormPostProcessor, PostProcessorServiceImpl

public interface PostProcessorRemote

A PostProcessor listens for events from the Workflow routing engine for it's DocumentType. It gives clients hooks into the routing process to perform operations at the various stages. Implementations of this Interface are potentially remotable, so this Interface uses value objects.

Author:

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

Method Summary

boolean	afterProcess(AfterProcessEventDTO event) The document has just completed processing by the Workflow engine.
boolean	beforeProcess(BeforeProcessEventDTO event) The document is about to be processed by the Workflow engine.
boolean	doActionTaken(ActionTakenEventDTO event) KEW is signaling that the document has had an action taken on it by a user
boolean	doDeleteRouteHeader(DeleteEventDTO event) KEW is signaling that the document should be deleted.
boolean	doRouteLevelChange(DocumentRouteLevelChangeDTO levelChangeEvent) The document has changed route level.
boolean	doRouteStatusChange(DocumentRouteStatusChangeDTO statusChangeEvent) The document has changed route status.
String[]	getDocumentIdsToLock(DocumentLockingEventDTO event) Executed prior to document locking in the workflow engine.

Method Detail

doRouteStatusChange

boolean doRouteStatusChange(DocumentRouteStatusChangeDTO statusChangeEvent)
                            throws RemoteException

The document has changed route status. The docEvent contains the information about the change. This method should do what ever is appropriate for various route status changes to a document. The method should return true if the change is correct and all application actions as a result of the change are successful. It should return false if the application considers this an incorrect change. The method can throw a ResourceUnavailableException in order to requeue the document and try again later.

Parameters:

statusChangeEvent -

msg - any error message to be propagated back to users should be set here

Returns:

true if the status change is correct and application actions are successful later if this exception is thrown

Throws:

RemoteException

See Also:

DocumentRouteStatusChange

doRouteLevelChange

boolean doRouteLevelChange(DocumentRouteLevelChangeDTO levelChangeEvent)
                           throws RemoteException

The document has changed route level. The docEvent contains the information about the change. This method should do what ever is appropriate for various route level changes to a document. The method should return true if the change is correct and all application actions as a result of the change are successful. It should return false if the application considers this an incorrect change. The method can throw a ResourceUnavailableException in order to requeue the document and try again later.

Parameters:

levelChangeEvent -

msg - any error message to be propagated back to users should be set here

Returns:

true if the status change is correct and application actions are successful

Throws:

Exception - A general Exception will put the document into Exception routing

ResourceUnavailableException - requeue the document and try the change again later if this exception is thrown

RemoteException

See Also:

DocumentRouteLevelChangeDTO

doDeleteRouteHeader

boolean doDeleteRouteHeader(DeleteEventDTO event)
                            throws RemoteException

KEW is signaling that the document should be deleted. The application can reject this by returning false. If an Exception is thrown the docuemnt will go to exception routing. If a ResourceUnavailableException is thrown, the doc will be requeued and will try again later to delete the document.

Parameters:

event -

message -

Returns:

Throws:

Exception - A general Exception will put the document into Exception routing

ResourceUnavailableException - requeue the document and try the change again

RemoteException

doActionTaken

boolean doActionTaken(ActionTakenEventDTO event)
                      throws RemoteException

KEW is signaling that the document has had an action taken on it by a user

Parameters:

event -

Returns:

Throws:

RemoteException

beforeProcess

boolean beforeProcess(BeforeProcessEventDTO event)
                      throws Exception

The document is about to be processed by the Workflow engine.

Parameters:

event - - holder for data from the engine's process

Returns:

true if the method is successful, false otherwise

Throws:

Exception - A general Exception will put the document into Exception routing

afterProcess

boolean afterProcess(AfterProcessEventDTO event)
                     throws Exception

The document has just completed processing by the Workflow engine.

Parameters:

event - - holder for data from the engine's process including whether the engine was successful or not

Returns:

true if the method is successful, false otherwise

Throws:

Exception - A general Exception will put the document into Exception routing

getDocumentIdsToLock

String[] getDocumentIdsToLock(DocumentLockingEventDTO event)
                              throws Exception

Executed prior to document locking in the workflow engine. This method returns an array 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 array of document ids to lock.

Returns:

an array of document ids to lock prior to execution of the workflow engine

Throws:

Exception