org.drools.runtime.rule.WorkingMemory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of drools-api
There is a newer version: 7.6.0.Final
package org.drools.runtime.rule;

import java.util.Collection;

/**
 * The WorkingMemory is a super-interface for all StatefulKnowledgeSessions.
 * Although, users are encouraged to use StatefulKnowledgeSession or KnowledgeRuntime
 * interface instead of WorkingMemory interface, specially because of the dispose() method
 * that is only available in the StatefulKnowledgeSession interface.  
 * 
 * @see org.drools.runtime.StatefulKnowledgeSession 
 */
public interface WorkingMemory
    extends
    WorkingMemoryEntryPoint {

    /**
     * Request the engine to stop firing rules. If the engine is currently firing a rule, it will
     * finish executing this rule's consequence before stopping.
     * This method will not remove active activations from the Agenda.
     * In case the application later wants to continue firing rules from the point where it stopped,
     * it should just call org.drools.runtime.StatefulKnowledgeSession.fireAllRules() or 
     * org.drools.runtime.StatefulKnowledgeSession.fireUntilHalt() again.
     */
    void halt();

    /**
     * Returns a reference to this session's Agenda.
     * 
     * @return
     */
    Agenda getAgenda();

    /**
     * Returns the WorkingMemoryEntryPoint instance associated with the given name.
     * 
     * @param name
     * @return
     */
    WorkingMemoryEntryPoint getWorkingMemoryEntryPoint(String name);
    
    /**
     * Returns a collection of all available working memory entry points
     * for this session.
     * 
     * @return the collection of all available entry points for this session
     */
    Collection getWorkingMemoryEntryPoints();
    
    /**
     * Retrieve the QueryResults of the specified query.
     *
     * @param query
     *            The name of the query.
     *
     * @return The QueryResults of the specified query.
     *         If no results match the query it is empty.
     *
     * @throws IllegalArgumentException
     *         if no query named "query" is found in the KnowledgeBase
     */
    public QueryResults getQueryResults(String query);

    /**
     * Retrieve the QueryResults of the specified query and arguments
     *
     * @param query
     *            The name of the query.
     *
     * @param arguments
     *            The arguments used for the query
     *
     * @return The QueryResults of the specified query.
     *         If no results match the query it is empty.
     *
     * @throws IllegalArgumentException
     *         if no query named "query" is found in the KnowledgeBase
     */
    public QueryResults getQueryResults(String query, Object[] arguments);      
}