org.kuali.rice.krms.api.engine
Interface Engine

All Known Implementing Classes:

ProviderBasedEngine

public interface Engine

An Engine executes using the given SelectionCriteria, @{link Facts}, and ExecutionOptions returning EngineResults

Author:

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

Method Summary

EngineResults	execute(SelectionCriteria selectionCriteria, Facts facts, ExecutionOptions executionOptions) Initiates execution of the rules engine.
EngineResults	execute(SelectionCriteria selectionCriteria, Map<String,Object> facts, ExecutionOptions executionOptions) Initiates execution of the rules engine.

Method Detail

execute

EngineResults execute(SelectionCriteria selectionCriteria,
                      Facts facts,
                      ExecutionOptions executionOptions)

Initiates execution of the rules engine.

Parameters:

selectionCriteria - informs the engine of the SelectionCriteria to use for selection of contexts and agendas

facts - the facts that the rule engine can use during execution

executionOptions - defines various ExecutionOptions that instruct the rules engine on how to perform it's execution

Returns:

EngineResults the results of engine execution

execute

EngineResults execute(SelectionCriteria selectionCriteria,
                      Map<String,Object> facts,
                      ExecutionOptions executionOptions)

Initiates execution of the rules engine.

Parameters:

selectionCriteria - informs the engine of the SelectionCriteria to use for selection of contexts and agendas

facts - the facts that the rule engine can use during execution. Since this signature does not pass in Terms, all terms are defined with only a name, and term parameters can not be specified.

executionOptions - defines various ExecutionOptions that instruct the rules engine on how to perform it's execution

Returns:

the results of engine execution