Package org.kuali.rice.kew.engine

Class StandardWorkflowEngine

java.lang.Object

org.kuali.rice.kew.engine.StandardWorkflowEngine

All Implemented Interfaces:

WorkflowEngine

Direct Known Subclasses:

BlanketApproveEngine, SimulationEngine

public class StandardWorkflowEngine
extends Object
implements WorkflowEngine

The standard and supported implementation of the WorkflowEngine. Runs a processing loop against a given Document, processing nodes on the document until the document is completed or a node halts the processing.

Author:

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

Field Summary

Fields

Modifier and Type	Field	Description
protected OrchestrationConfig	config
protected final RouteHelper	helper
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	parameterService
protected RouteHeaderService	routeHeaderService
protected RouteNodeService	routeNodeService

Constructor Summary

Constructors

Modifier	Constructor	Description
	StandardWorkflowEngine()
protected	StandardWorkflowEngine(RouteNodeService routeNodeService, RouteHeaderService routeHeaderService, org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService, OrchestrationConfig config)

Method Summary

Modifier and Type	Method	Description
protected void	flushDatabaseWork(RouteContext context)	Flush using DocumentRouteHeaderValue to identify the context in which to flush database changes.
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
protected RouteHeaderService	getRouteHeaderService()
protected RouteNodeService	getRouteNodeService()
void	initializeDocument(DocumentRouteHeaderValue document)	This method initializes the document by materializing and activating the first node instance on the document.
boolean	isRunPostProcessorLogic()
protected void	lockAdditionalDocuments(DocumentRouteHeaderValue document)
protected DocumentRouteHeaderValue	nodePostProcess(RouteContext context)
void	process(String documentId)
protected ProcessContext	processNodeInstance(RouteContext context, RouteHelper helper)
protected RouteNodeInstance	saveNode(RouteContext context, RouteNodeInstance nodeInstance)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)
void	setRouteHeaderService(RouteHeaderService routeHeaderService)
void	setRouteNodeService(RouteNodeService routeNodeService)

Methods inherited from class java.lang.Object

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

Field Details

helper

protected final RouteHelper helper

routeNodeService

protected RouteNodeService routeNodeService

routeHeaderService

protected RouteHeaderService routeHeaderService

parameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService

config

protected OrchestrationConfig config

Constructor Details

StandardWorkflowEngine

public StandardWorkflowEngine()

StandardWorkflowEngine

protected StandardWorkflowEngine(RouteNodeService routeNodeService,
 RouteHeaderService routeHeaderService,
 org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService,
 OrchestrationConfig config)

Method Details

isRunPostProcessorLogic

public boolean isRunPostProcessorLogic()

process

public void process(String documentId)
             throws Exception

Specified by:

process in interface WorkflowEngine

Throws:

Exception

processNodeInstance

protected ProcessContext processNodeInstance(RouteContext context,
 RouteHelper helper)
                                      throws Exception

Throws:

Exception

saveNode

protected RouteNodeInstance saveNode(RouteContext context,
 RouteNodeInstance nodeInstance)

flushDatabaseWork

protected void flushDatabaseWork(RouteContext context)

Flush using DocumentRouteHeaderValue to identify the context in which to flush database changes.

nodePostProcess

protected DocumentRouteHeaderValue nodePostProcess(RouteContext context)
                                            throws org.kuali.rice.kew.api.exception.InvalidActionTakenException

Throws:

org.kuali.rice.kew.api.exception.InvalidActionTakenException

lockAdditionalDocuments

protected void lockAdditionalDocuments(DocumentRouteHeaderValue document)
                                throws Exception

Throws:

Exception

initializeDocument

public void initializeDocument(DocumentRouteHeaderValue document)

This method initializes the document by materializing and activating the first node instance on the document.

Specified by:

initializeDocument in interface WorkflowEngine

getRouteNodeService

protected RouteNodeService getRouteNodeService()

getRouteHeaderService

protected RouteHeaderService getRouteHeaderService()

getParameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

setRouteNodeService

public void setRouteNodeService(RouteNodeService routeNodeService)

setRouteHeaderService

public void setRouteHeaderService(RouteHeaderService routeHeaderService)

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)