com.ibm.rules.engine.ruledef.runtime

Interface RuleEngine

All Superinterfaces:

Engine, EngineServices, EngineWithWorkingMemory, Observable

All Known Subinterfaces:

SteppingRuleEngine

public interface RuleEngine
extends EngineWithWorkingMemory

RuleEngine represents a rule engine instance.

See Also:

RuleEngineDefinition to see how to create an engine instance.

Method Summary

Modifier and Type	Method and Description
RuleEngineInput	createRuleEngineInput() Creates an input object for a RuleEngine.
RuleEngineInput	createRuleEngineInput(EngineData data) Creates an input object for a RuleEngine.
RuleEngineOutput	execute(RuleEngineInput input) Executes rules.
RuleEngineDefinition	getDefinition() Returns the engine definition.

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, getAllObservers, getSupportedObserverClasses, removeAllObservers, removeObserver, removeObserver

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

getNumberOfServices, getService, getServiceByName, getServiceClasses

Method Detail

getDefinition

RuleEngineDefinition getDefinition()

Returns the engine definition.

Specified by:

getDefinition in interface Engine

Returns:

The engine definition.

execute

RuleEngineOutput execute(RuleEngineInput input)
                  throws EngineExecutionException,
                         EngineInvalidStateException,
                         java.lang.IllegalArgumentException

Executes rules.

Throws:

EngineExecutionException - when an exception occurs during a condition test evaluation or rule action execution.

EngineInvalidStateException - when the the internal state of the engine is not compatible with the way this method has been called.

java.lang.IllegalArgumentException - when the input parameter is not valid.

Parameters:

input - The rule engine input.

Returns:

The output given when a RuleEngine is executed.

createRuleEngineInput

RuleEngineInput createRuleEngineInput()

Creates an input object for a RuleEngine. You use the RuleEngineInput object returned to parameterize Engine execution.

Returns:

A new rule engine input.

createRuleEngineInput

RuleEngineInput createRuleEngineInput(EngineData data)
                               throws java.lang.IllegalArgumentException

Creates an input object for a RuleEngine. You use the RuleEngineInput object returned to parameterize Engine execution.

Throws:

java.lang.IllegalArgumentException - when data is not valid.

Parameters:

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

Returns:

A new rule engine input.

See Also:

EngineInput.getData()