|
Rule Execution Server API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RunningEngineWithWorkingMemory
Use the RunningEngineWithWorkingMemory
interface only inside a RunningEngine
. For
example, in rules, tasks, or B2X
Method Summary | |
---|---|
Collection<Object> |
getWorkingMemory()
Returns the working memory of the RuleEngine . |
void |
insert(Object o)
Inserts an object into working memory. |
void |
retract(Object o)
Removes an object from working memory. |
void |
retractAll()
Removes all the objects from working memory. |
void |
update(Object o)
Updates an object in working memory if the object has been asserted. |
void |
updateData()
Updates the EngineData to ensure that the objects it references are
consistent with the Agenda . |
void |
updateGenerator(Object generator)
Updates a generator. |
void |
updateGenerators()
Updates the generators. |
void |
updateGeneratorsElement(Object element)
Updates a generator. |
Methods inherited from interface com.ibm.rules.engine.runtime.RunningEngine |
---|
note, stop |
Methods inherited from interface com.ibm.rules.engine.service.EngineServices |
---|
getNumberOfServices, getService, getServiceByName, getServiceClasses |
Method Detail |
---|
Collection<Object> getWorkingMemory()
RuleEngine
.
void insert(Object o) throws EngineExecutionException, EngineInvalidStateException
o
is already in working memory, a normal update is
performed.
EngineInvalidStateException
- raised when the engine is set in the stop state
EngineExecutionException
o
- The object to insert.void retract(Object o) throws EngineExecutionException, EngineInvalidStateException
EngineInvalidStateException
- when the Engine
is set in the stop state.
EngineExecutionException
o
- The object to remove.void retractAll() throws EngineExecutionException, EngineInvalidStateException
EngineInvalidStateException
- when the Engine
is set in the stop state.
EngineExecutionException
void update(Object o) throws EngineExecutionException, EngineInvalidStateException
Rule
that uses this object is true
, a Rule
instance is
inserted into the Agenda
and the Rule
applies for as long as
it can be fired.
EngineExecutionException
- raised when an exception occurs during a condition test
evaluation or a rule action execution.
EngineInvalidStateException
- raised when the engine is set in the stop stateo
- The object to update.void updateGenerator(Object generator) throws EngineExecutionException, EngineInvalidStateException
generator
are used in the in/from condition for
a Rule
.
EngineExecutionException
- when an exception occurs during condition test
evaluation or RuleAction
execution.
EngineInvalidStateException
- when the Engine
is set in the stop state.generator
- The object referencing a generator.void updateGeneratorsElement(Object element) throws EngineExecutionException, EngineInvalidStateException
element
is used in the in/from condition for
a Rule
.
EngineExecutionException
- when an exception occurs during condition test
evaluation or RuleAction
execution.
EngineInvalidStateException
- when the Engine
is set in the stop state.element
- The object referencing a generator.void updateGenerators() throws EngineExecutionException, EngineInvalidStateException
Rule
when a static method is called.
EngineExecutionException
- when an exception occurs during condition test
evaluation or RuleAction
execution.
EngineInvalidStateException
- when the Engine
is set in the stop state.void updateData() throws EngineExecutionException, EngineInvalidStateException
EngineData
to ensure that the objects it references are
consistent with the Agenda
.
If the Rule
objects run by this Engine
contain references to
objects that are accessed using EngineData
in the Rule
instances,
and if these objects have been modified, call this method to ensure that the
Agenda
is in a consistent state with the objects referenced by the
EngineData
.
EngineExecutionException
- raised when an exception occurs during a condition test
evaluation or a rule action execution.
EngineInvalidStateException
- raised when the engine is set in the stop state
|
Rule Execution Server API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |