Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| jBPM distribution 6.1.0-SNAPSHOT
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.kie.api.runtime.rule
Interface RuleRuntime

All Superinterfaces:
  EntryPoint

All Known Subinterfaces:
  KieRuntime, KieSession

All Known Implementing Classes:
  StatefulProcessSession

    public interface RuleRuntime

extends EntryPoint

The `RuleRuntime` is a super-interface for all `KieSession`s. Although, users are encouraged to use `KieSession` or `KnowledgeRuntime` interface instead of `RuleRuntime` interface, specially because of the `dispose()` method that is only available in the `KieSession` interface.

See Also:
  `KieSession`

Method Summary
`Agenda` | `getAgenda()` Returns a reference to this session's `Agenda`.
`EntryPoint` | `getEntryPoint(String name)` Returns the WorkingMemoryEntryPoint instance associated with the given name.
`Collection<? extends EntryPoint>` | `getEntryPoints()` Returns a collection of all available working memory entry points for this session.
`QueryResults` | `getQueryResults(String query, Object... arguments)` Retrieve the QueryResults of the specified query and arguments
`void` | `halt()` Request the engine to stop firing rules.
`LiveQuery` | `openLiveQuery(String query, Object[] arguments, ViewChangedEventListener listener)`

Methods inherited from interface org.kie.api.runtime.rule.EntryPoint
`delete, getEntryPointId, getFactCount, getFactHandle, getFactHandles, getFactHandles, getObject, getObjects, getObjects, insert, retract, update`

Method Detail

### halt

    void halt()

  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 Matches from the Agenda. In case the application later wants to continue firing rules from the point where it stopped, it should just call `org.kie.api.runtime.StatefulKnowledgeSession.fireAllRules()` or `org.kie.api.runtime.StatefulKnowledgeSession.fireUntilHalt()` again.

### getAgenda

    Agenda getAgenda()

  Returns a reference to this session's `Agenda`.

  Returns:

### getEntryPoint

    EntryPoint getEntryPoint(String name)

  Returns the WorkingMemoryEntryPoint instance associated with the given name.

  Parameters:
    `name` -
  Returns:

### getEntryPoints

    Collection<? extends EntryPoint> getEntryPoints()

  Returns a collection of all available working memory entry points for this session.

  Returns:
    the collection of all available entry points for this session

### getQueryResults

    QueryResults getQueryResults(String query,
                                 Object... arguments)

  Retrieve the QueryResults of the specified query and arguments

  Parameters:
    `query` - The name of the query.
    `arguments` - The arguments used for the query
  Returns:
    The QueryResults of the specified query. If the query does not exist or no results match the query it is empty.

### openLiveQuery

    LiveQuery openLiveQuery(String query,
                            Object[] arguments,
                            ViewChangedEventListener listener)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| jBPM distribution 6.1.0-SNAPSHOT
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2014 JBoss by Red Hat. All Rights Reserved.