org.kuali.rice.kew.framework.support.krms

Interface RulesEngineExecutor

public interface RulesEngineExecutor

Serves as an interface to execution of a rules engine during execution of the workflow engine. Applications that wish to integrate with KRMS from the workflow engine should implement an executor and make it available to the workflow engine in one of two ways:

1. Register an extension with KEW (by ingesting a file containing a <ruleAttribute> mapping a name to the implementation class for the RulesEngineExecutor. This name can then be referenced within the route node definition.
2. Simply reference the fully-qualified class name of the RulesEngineExecutor implementation class inside of the route node definition

In the first case, the route node definition would look similar to the following:

 
 <requests name="MyRulesBasedNode">
   <rulesEngine executor="MyRulesEngineExecutor"/>
 </requests>
 
 

The above assumes that an extension/rule attribute has been defined with the name of "MyRulesEngineExecutor".

Alternatively, the fully-qualified class name can be specified directly as follows:

 
 <requests name="MyRulesBasedNode">
   <rulesEngine executorClass="MyRulesEngineExecutor"/>
 </requests>
 
 

TODO - this interface should really be part of the framework module, but depends on RouteContext which is currently part of the impl module.

Author:

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

Method Summary

Modifier and Type	Method and Description
EngineResults	execute(RouteContext routeContext, Engine engine)

Method Detail

execute

EngineResults execute(RouteContext routeContext,
                      Engine engine)