org.drools.runtime.rule.WorkingMemoryEntryPoint Maven / Gradle / Ivy
package org.drools.runtime.rule;
/**
* An entry-point is an abstract channel through where facts are inserted into the engine.
* Drools 5 supports multiple entry-points into a single StatefulKnowledgeBase: the
* default, anonymous entry-point, as well as as many user declared entry points the application
* requires.
*
* To get a reference to an entry point, just request the session:
*
* StatefulKnowledgeSession session = kbase.newStatelessKnowledgeSession();
* ...
* WorkingMemoryEntryPoint entrypoint = session.getWorkingMemoryEntryPoint("my entry point");
*
* Once a reference to an entry point is acquired, the application can insert, update and retract facts
* to/from that entry-point as usual:
*
* ...
* FactHandle factHandle = entrypoint.insert( fact );
* ...
* entrypoint.update( factHandle, newFact );
* ...
* entrypoint.retract( factHandle );
* ...
*
*
*/
public interface WorkingMemoryEntryPoint {
/**
* Inserts a new fact into this entry point
*
* @param object
* the fact to be inserted
*
* @return the fact handle created for the given fact
*/
FactHandle insert(Object object);
/**
* Retracts the fact for which the given FactHandle was assigned.
*
* @param handle the handle whose fact is to be retracted.
*/
void retract(FactHandle handle);
/**
* Updates the fact for which the given FactHandle was assigned with the new
* fact set as the second parameter in this method.
*
* @param handle the FactHandle for the fact to be updated.
*
* @param object the new value for the fact being updated.
*/
void update(FactHandle handle,
Object object);
}