|
Rule Execution Server API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Engine
Use this Engine
interface to parametrize and run an Engine
instance.
You create an Engine
using an EngineDefinition
object.
EngineDefinition
Method Summary | |
---|---|
EngineInput |
createInput()
Creates an EngineInput object for this Engine . |
EngineInput |
createInput(EngineData data)
Creates an EngineInput object for this Engine . |
EngineOutput |
execute(EngineInput input)
Executes this Engine using the input then returns the output. |
EngineOutput |
execute(Map<String,Object> input)
Executes this Engine using a Map of associated
strings and objects, then returns the output. |
EngineDefinition |
getDefinition()
Returns the EngineDefinition . |
EngineState |
getState()
Return the current state of this Engine instance. |
void |
note(String note)
Adds a note to this Engine . |
void |
reset()
Clears the content of the working memory for this Engine . |
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 |
---|
EngineOutput execute(Map<String,Object> input) throws EngineExecutionException, EngineInvalidStateException, IllegalArgumentException
Engine
using a Map
of associated
strings and objects, then returns the output.
EngineExecutionException
- if there is a problem running this engine.
EngineInvalidStateException
- if this engine is not in the correct state.
IllegalArgumentException
- if input
cannot be used by this engine.input
- The input.
EngineOutput execute(EngineInput input) throws EngineExecutionException, EngineInvalidStateException, IllegalArgumentException
Engine
using the input then returns the output.
EngineExecutionException
- if there is a problem running this engine.
EngineInvalidStateException
- if this engine is not in the correct state.
IllegalArgumentException
- if input
cannot be used by this engine.input
- The input.
EngineDefinition getDefinition()
EngineDefinition
.
EngineDefinition
.void reset()
Engine
.
EngineInput createInput()
EngineInput
object for this Engine
.
Use the object returned to parametrize Engine
execution.
EngineInput createInput(EngineData data)
EngineInput
object for this Engine
.
Use the object returned to parametrize Engine
execution.
data
- The EngineData
that will be accessible using the input
returned.
EngineInput.getData()
void note(String note)
Engine
.
This note is sent to the NoteObserver
objects.
note
- The note to add.NoteObserver
EngineState getState()
Engine
instance.
Engine
.
|
Rule Execution Server API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |