Skip navigation links

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

All Superinterfaces:

Engine, EngineServices, EngineWithWorkingMemory, Observable

All Known Subinterfaces:

RunningRuleflowEngine

public interface RuleflowEngine
extends EngineWithWorkingMemory

RuleflowEngine represents a ruleflow engine.

See Also:

for creating a ruleflow engine

Method Summary

RuleflowEngineInput	createRuleflowEngineInput() Creates an input for this RuleflowEngine.
RuleflowEngineInput	createRuleflowEngineInput(EngineData data) Creates an input for this RuleflowEngine.
RuleflowEngineOutput	execute(RuleflowEngineInput input) Executes the ruleflow.
RuleflowEngineDefinition	getDefinition() Returns the definition used to created this RuleflowEngine instance.

Methods inherited from interface com.ibm.rules.engine.runtime.EngineWithWorkingMemory

execute

Methods inherited from interface com.ibm.rules.engine.runtime.Engine

createInput, createInput, execute, execute, getState, note, reset

Methods inherited from interface com.ibm.rules.engine.observer.Observable

addObserver, addObserver, getSupportedObserverClasses, removeAllObservers, removeObserver, removeObserver

Methods inherited from interface com.ibm.rules.engine.service.EngineServices

getNumberOfServices, getService, getServiceByName, getServiceClasses

Method Detail

createRuleflowEngineInput

RuleflowEngineInput createRuleflowEngineInput()

Creates an input for this RuleflowEngine. Use this input to parameterize Engine execution.

Returns:

A new RuleflowEngineInput.

createRuleflowEngineInput

RuleflowEngineInput createRuleflowEngineInput(EngineData data)

Creates an input for this RuleflowEngine. Use this input to parameterize engine execution.

Parameters:

data - The engine data which will be accessible through this input.

Returns:

A new RuleflowEngineInput.

See Also:

EngineInput.getData()

execute

RuleflowEngineOutput execute(RuleflowEngineInput input)
                             throws EngineExecutionException,
                                    EngineInvalidStateException,
                                    IllegalArgumentException

Executes the ruleflow.

Throws:

EngineExecutionException

EngineInvalidStateException

IllegalArgumentException

Parameters:

input - The ruleflow engine input.

Returns:

The output given when this RuleflowEngine is executed.

getDefinition

RuleflowEngineDefinition getDefinition()

Returns the definition used to created this RuleflowEngine instance.

Specified by:

getDefinition in interface Engine

Returns:

The definition used to created this RuleflowEngine instance.

See Also:

RuleEngine.getDefinition()