Package org.kuali.rice.krad.service.impl

Class PostProcessorServiceImpl

java.lang.Object

org.kuali.rice.krad.service.impl.PostProcessorServiceImpl

All Implemented Interfaces:

org.kuali.rice.kew.framework.postprocessor.PostProcessor, PostProcessorService

@Transactional
public class PostProcessorServiceImpl
extends Object
implements PostProcessorService

This class is the postProcessor for the Kuali application, and it is responsible for plumbing events up to documents using the built into the document methods for handling route status and other routing changes that take place asyncronously and potentially on a different server.

Author:

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

Constructor Summary

Constructors

Constructor	Description
PostProcessorServiceImpl()

Method Summary

Modifier and Type	Method	Description
org.kuali.rice.kew.framework.postprocessor.ProcessDocReport	afterActionTaken(org.kuali.rice.kew.api.action.ActionType performed, org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent event)
org.kuali.rice.kew.framework.postprocessor.ProcessDocReport	afterProcess(org.kuali.rice.kew.framework.postprocessor.AfterProcessEvent event)	This method first checks to see if the document can be retrieved by the DocumentService.
org.kuali.rice.kew.framework.postprocessor.ProcessDocReport	beforeProcess(org.kuali.rice.kew.framework.postprocessor.BeforeProcessEvent event)	This method first checks to see if the document can be retrieved by the DocumentService.
org.kuali.rice.kew.framework.postprocessor.ProcessDocReport	doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent event)
org.kuali.rice.kew.framework.postprocessor.ProcessDocReport	doDeleteRouteHeader(org.kuali.rice.kew.framework.postprocessor.DeleteEvent event)
org.kuali.rice.kew.framework.postprocessor.ProcessDocReport	doRouteLevelChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange levelChangeEvent)
org.kuali.rice.kew.framework.postprocessor.ProcessDocReport	doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)
protected UserSession	establishPostProcessorUserSession()	Establishes the UserSession if one does not already exist.
List<String>	getDocumentIdsToLock(org.kuali.rice.kew.framework.postprocessor.DocumentLockingEvent event)	This method first checks to see if the document can be retrieved by the DocumentService.
final void	setDocumentService(DocumentService documentService)	Sets the documentService attribute value.

Methods inherited from class java.lang.Object

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

Constructor Details

PostProcessorServiceImpl

public PostProcessorServiceImpl()

Method Details

doRouteStatusChange

public org.kuali.rice.kew.framework.postprocessor.ProcessDocReport doRouteStatusChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange statusChangeEvent)
                                                                                throws Exception

Specified by:

doRouteStatusChange in interface org.kuali.rice.kew.framework.postprocessor.PostProcessor

Throws:

Exception

doRouteLevelChange

public org.kuali.rice.kew.framework.postprocessor.ProcessDocReport doRouteLevelChange(org.kuali.rice.kew.framework.postprocessor.DocumentRouteLevelChange levelChangeEvent)
                                                                               throws Exception

Specified by:

doRouteLevelChange in interface org.kuali.rice.kew.framework.postprocessor.PostProcessor

Throws:

Exception

doDeleteRouteHeader

public org.kuali.rice.kew.framework.postprocessor.ProcessDocReport doDeleteRouteHeader(org.kuali.rice.kew.framework.postprocessor.DeleteEvent event)
                                                                                throws Exception

Specified by:

doDeleteRouteHeader in interface org.kuali.rice.kew.framework.postprocessor.PostProcessor

Throws:

Exception

doActionTaken

public org.kuali.rice.kew.framework.postprocessor.ProcessDocReport doActionTaken(org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent event)
                                                                          throws Exception

Specified by:

doActionTaken in interface org.kuali.rice.kew.framework.postprocessor.PostProcessor

Throws:

Exception

afterActionTaken

public org.kuali.rice.kew.framework.postprocessor.ProcessDocReport afterActionTaken(org.kuali.rice.kew.api.action.ActionType performed,
 org.kuali.rice.kew.framework.postprocessor.ActionTakenEvent event)
                                                                             throws Exception

Specified by:

afterActionTaken in interface org.kuali.rice.kew.framework.postprocessor.PostProcessor

Throws:

Exception

afterProcess

public org.kuali.rice.kew.framework.postprocessor.ProcessDocReport afterProcess(org.kuali.rice.kew.framework.postprocessor.AfterProcessEvent event)
                                                                         throws Exception

This method first checks to see if the document can be retrieved by the DocumentService. If the document is found the Document.afterWorkflowEngineProcess(boolean) method will be invoked on it

Specified by:

afterProcess in interface org.kuali.rice.kew.framework.postprocessor.PostProcessor

Throws:

Exception

beforeProcess

public org.kuali.rice.kew.framework.postprocessor.ProcessDocReport beforeProcess(org.kuali.rice.kew.framework.postprocessor.BeforeProcessEvent event)
                                                                          throws Exception

This method first checks to see if the document can be retrieved by the DocumentService. If the document is found the Document.beforeWorkflowEngineProcess() method will be invoked on it

Specified by:

beforeProcess in interface org.kuali.rice.kew.framework.postprocessor.PostProcessor

Throws:

Exception

getDocumentIdsToLock

public List<String> getDocumentIdsToLock(org.kuali.rice.kew.framework.postprocessor.DocumentLockingEvent event)
                                  throws Exception

This method first checks to see if the document can be retrieved by the DocumentService. If the document is found the Document.beforeWorkflowEngineProcess() method will be invoked on it

Specified by:

getDocumentIdsToLock in interface org.kuali.rice.kew.framework.postprocessor.PostProcessor

Throws:

Exception

setDocumentService

public final void setDocumentService(DocumentService documentService)

Sets the documentService attribute value.

Parameters:

documentService - The documentService to set.

establishPostProcessorUserSession

protected UserSession establishPostProcessorUserSession()
                                                 throws org.kuali.rice.kew.api.exception.WorkflowException

Establishes the UserSession if one does not already exist.

Throws:

org.kuali.rice.kew.api.exception.WorkflowException