Rule Execution Server API

com.ibm.rules.engine.ruleflow.runtime
Interface RuleflowEngineDefinition

All Superinterfaces:
EngineDefinition, EngineServices

public interface RuleflowEngineDefinition
extends EngineDefinition

Use an RuleflowEngineDefinition instance to create RuleflowEngine instances and to access Task definitions.


Method Summary
 RuleflowEngine createEngine()
          Creates a RuleflowEngine instance..
 RuleflowEngine createEngine(EngineService... services)
          Creates a RuleflowEngine.
 Task getMainTask()
          Returns the ruleflow engine definition main Task.
 Task getTask(String taskName)
          Returns a specific Task.
 List<Task> getTasks()
          Returns the Task objects for this RuleflowEngine.
 
Methods inherited from interface com.ibm.rules.engine.runtime.EngineDefinition
getSignature
 
Methods inherited from interface com.ibm.rules.engine.service.EngineServices
getNumberOfServices, getService, getServiceByName, getServiceClasses
 

Method Detail

createEngine

RuleflowEngine createEngine()
Creates a RuleflowEngine instance..

Specified by:
createEngine in interface EngineDefinition
Returns:
A new RuleflowEngine.

createEngine

RuleflowEngine createEngine(EngineService... services)
Creates a RuleflowEngine.

Specified by:
createEngine in interface EngineDefinition
Parameters:
services - EngineServices to be used by the new engine. This overrides the default EngineServices in the engine definition.
Returns:
A new RuleflowEngine.

getTasks

List<Task> getTasks()
Returns the Task objects for this RuleflowEngine.

Returns:
The tasks. If no Task objects are present, an empty list is returned.

getTask

Task getTask(String taskName)
Returns a specific Task.

Parameters:
taskName - The name of the Task to be returned.
Returns:
The task that matches taskName. If a task matching this name does not exist, null is returned.

getMainTask

Task getMainTask()
Returns the ruleflow engine definition main Task. Note that it is immutable.

Returns:
The main task

Rule Execution Server API

© Copyright IBM Corp. 1987, 2013