ILOG JRules

The APIs listed in this documentation are the only supported JRules APIs - any API (class, interface, method, constructor or member) in an ilog package not explicitly listed in this documentation is subject to change or removal without prior deprecation in any subsequent release (including technical releases) of JRules, and its use in customer code is not supported.

See:
          Description

Packages
ilog.rules.archive Contains the classes needed to build a ruleset archive and extract its contents, without any interpretation of the contents.
ilog.rules.bom Defines the object model access API.
ilog.rules.bom.dynamic Contains an implementation of the object model.
ilog.rules.bom.mutable Defines the object model mutable API.
ilog.rules.bom.serializer Contains the IlrSerializer interface which can read and write an object model.
ilog.rules.bom.util Contains miscellaneous utility classes.
ilog.rules.bres.jsr94 Provides the classes that implements the JavaTM Rule Engine API (JSR-94) on top of Rule Execution Server.
ilog.rules.bres.model Provides interfaces for the Rule Execution Server management model.
ilog.rules.bres.model.archive Provides the ability to backup a ruleApp or a Set of ruleApp to a ruleApp archive.
ilog.rules.bres.model.mbean Provides interfaces for Rule Execution Server management MBeans.
ilog.rules.bres.model.mbean.util Provides classes that abstract the JMX cluster complexity when you use Rule Execution Server management MBeans in an application server.
ilog.rules.bres.ras.model Provides the interfaces of the Rule Execution Server and Rule Scenario Manager integration model.
ilog.rules.bres.ras.model.impl Provides the implementation of the Rule Execution Server and Rule Scenario Manager integration model.
ilog.rules.bres.session Provides the core classes and interfaces of the JRules rule sessions.
ilog.rules.bres.session.ejb Provides EJB rule session implementation classes for the J2EE platform.
ilog.rules.bres.session.interceptor Provides an API to implement a ruleset execution interceptor.
ilog.rules.bres.session.j2se Provides a simple Java rule session implementation that can be used with the Execution Unit (XU) without an application server.
ilog.rules.bres.session.java Provides a simple Java rule session implementation that can be used with the Execution Unit (XU) in an application server.
ilog.rules.bres.session.util Provides useful classes designed for general support of rule sessions.
ilog.rules.bres.xu.cci Provides classes related to the XU CCI implementation.
ilog.rules.bres.xu.cmanager Provides classes and interfaces for implementing a custom pool that can be used by the Execution Unit (XU).
ilog.rules.bres.xu.event Provides classes and interfaces on the events used by the Execution Unit (XU).
ilog.rules.bres.xu.plugin Provides classes for implementing Execution Unit (XU) plug-ins.
ilog.rules.brl Contains classes related to the Business Rule Language Definition Framework (BRLDF).
ilog.rules.brl.bal60 Contains classes related to the Business Action Language.
ilog.rules.brl.bql Contains classes related to the Business Query Language (BQL).
ilog.rules.brl.brldf Contains classes related to the the definition of new business rule languages with the Business Rule Language Definition Framework (BRLDF).
ilog.rules.brl.converter Contains classes related to the BRL converter, which allows conversion of a rule from one grammar to another.
ilog.rules.brl.parsing Contains classes related to the BRL parser.
ilog.rules.brl.semantic Contains classes for managing the semantics of business rule languages.
ilog.rules.brl.syntaxtree Contains classes related to the business rule language Abstract Syntax Tree.
ilog.rules.brl.translation Contains classes related to the IRL translation framework for business rule artifacts.
ilog.rules.brl.translation.codegen Contains classes related to code generation in the IRL translation framework for business rules.
ilog.rules.brl.ui.value.editor Contains classes related to UI components for value editors.
ilog.rules.brl.util Contains utility classes related to the BRL defintion framework.
ilog.rules.brl.value.descriptor Contains classes related to value descriptors.
ilog.rules.brl.value.editor Contains classes related to value editors.
ilog.rules.brl.value.info Contains classes related to value info, value providers, and value checkers.
ilog.rules.commonbrm.extractor Provides the classes for defining extractors in Rule Studio and Rule Team Server.
ilog.rules.commonbrm.model Provides the common classes for the models of Rule Studio and Rule Team Server.
ilog.rules.debug Provides the IlrLocalTracerToolFactory class, which allows you to create a local trace.
ilog.rules.dt Contains classes related to Decision Table and Decision Tree.
ilog.rules.dt.model Contains interfaces defining a decision table model and all its structural elements.
ilog.rules.dt.model.event Provides interfaces and class adapters defining the event system of a decision table model.
ilog.rules.dt.model.expression Provides interfaces defining the expression model of a decision table model.
ilog.rules.dt.model.helper Contains companion classes for a DT model.
ilog.rules.dt.model.provider Contains the interface of a data provider to be used to populate a decision table model.
ilog.rules.dtree.ui Contains classes related to Decision Tree User Interface.
ilog.rules.engine Provides the core classes of the JRules rule engine, otherwise known as an inference engine.
ilog.rules.factory Contains the Factory API, which provides introspection functionality for JRules rules.
ilog.rules.factory.translation Contains the Translation API, which supports the creation and modification of translations between rules based on a business model and rules based on an execution model.
ilog.rules.ras.binding

Provides the core classes to offer binding facilities.

ilog.rules.ras.binding.birt Provides the core classes to offer binding using BIRT (HTML or PDF formats).
ilog.rules.ras.binding.excel Provides the classes needed to bind with Excel data elements.
ilog.rules.ras.binding.excel.impl

A sample implementation of a databinding class as an Excel representation.

ilog.rules.ras.binding.xml Provides classes needed to bind with XML data elements.
ilog.rules.ras.binding.xml.impl

Sample implementation of a binding class as an XML representation.

ilog.rules.ras.core

Provides the core model of Rule Scenario Manager.

ilog.rules.ras.core.archive

Provides the classes needed to manage RSM archives.

ilog.rules.ras.core.archive.wrapper

Provides the classes needed to manage wrappers of RSM archives.

ilog.rules.ras.core.binding

Provides the basic classes for binding.

ilog.rules.ras.core.binding.impl Provides the default implementation for binding.
ilog.rules.ras.core.execution Provides classes and interfaces used for both the functional and logical representation of an execution trace.
ilog.rules.ras.core.execution.impl Provides the default implementation of execution trace representation.
ilog.rules.ras.core.executor

Provides the class for executors.

ilog.rules.ras.core.extractor

Provides the core classes to extract data from a ruleset execution response.

ilog.rules.ras.core.kpi

Provides the core classes to perform KPI computations on scenario suites and simulations.

ilog.rules.ras.core.operator

Provides the core classes for the operators used in tests.

ilog.rules.ras.core.result

Provides the core classes to manage execution results.

ilog.rules.ras.core.scenario Provides the key utility interfaces for a scenario and its tests.
ilog.rules.ras.core.scenario.impl Provides the key utility classes implementation for a scenario and its tests.
ilog.rules.ras.core.scenario.impl.wrapper

Default implementations of the results wrappers.

ilog.rules.ras.core.scenario.wrapper

Provides the core classes to manage results.

ilog.rules.ras.core.type

Provides all the types usable in the tests.

ilog.rules.ras.extractor

Provides the core classes for all extractors used in tests.

ilog.rules.ras.operator

Provides the core classes for all operators used in tests.

ilog.rules.ras.tools

Provides tools classes.

ilog.rules.ras.tools.engine

Provides tools classes for managing the engine response.

ilog.rules.ras.tools.repository

Provides tools classes for managing information from repository.

ilog.rules.ras.tools.resource

Provides tools classes for managing resources.

ilog.rules.ras.tools.resource.exceptions

Provides exception classes for managing resources.

ilog.rules.ras.tools.ruleset

Provides tools classes for managing the ruleset.

ilog.rules.ras.type

Provides all predefined data types associated with the operators for testing the input data.

ilog.rules.res.decisionservice.mbean Provides a decision service MBean.
ilog.rules.shared.model Contains interface and base classes for decorable elements.
ilog.rules.studio.javascript Provides classes to manage the life cycle of the Rule Studio command-line tool.
ilog.rules.studio.javascript.dom Provides the ilog.rules.studio.eclipsemonkey.dom extensions, and the factories that support the global variables available in the JavaScript.
ilog.rules.studio.model Contains some base classes for the model of Rule Studio.
ilog.rules.studio.model.archive Provides classes for generating ruleset archives.
ilog.rules.studio.model.base Provides uncategorized base model classes.
ilog.rules.studio.model.bom Provides model classes related to the Business Object Model.
ilog.rules.studio.model.brl Contains model classes for business rule languages in Rule Studio.
ilog.rules.studio.model.builder Provides classes related to the build operation in Rule Studio.
ilog.rules.studio.model.dt Contains model classes of decision tables and decision trees.
ilog.rules.studio.model.event Provides classes of Listeners and Events for the model of Rule Studio.
ilog.rules.studio.model.exception Provides the exceptions thrown by the Rule Studio model.
ilog.rules.studio.model.irl Contains the classes managing Technical Rules in the model of Rule Studio.
ilog.rules.studio.model.query Contains classes managing queries in Rule Studio.
ilog.rules.studio.model.query.extractor Contains the classes managing query extractors in Rule Studio.
ilog.rules.studio.model.query.wrappers Contains classes related to the Rules Queries API.
ilog.rules.studio.model.resource Provides classes for managing resources in Rule Studio.
ilog.rules.studio.model.rule Provides model classes for rule artifacts.
ilog.rules.studio.model.ruleflow Contains the model of the ruleflow and its tasks, with the definitions of the enumerated values used in their attributes.
ilog.rules.studio.model.search Provides classes for searches.
ilog.rules.studio.model.search.bom Provides BOM search capability.
ilog.rules.studio.model.search.rdt Provides the RDT (model) search functionality.
ilog.rules.studio.model.search.xom Provides XOM search capability.
ilog.rules.studio.model.xom Provides model classes related to the Execution Object Model.
ilog.rules.studio.res Provides a interface to manage Rule Execution Server Configurations in Rule Studio.
ilog.rules.studio.res.generator Provides a set of abstract classes that can be extended to create and add a new generator for a Client Project for Ruleapps in Rule Studio.
ilog.rules.studio.res.generator.impl Provides classes that extend the velocity template.
ilog.rules.studio.res.ruleapp Provides a set of interfaces to manage RuleApps and RuleApp projects in Rule Studio.
ilog.rules.studio.res.ui.generator.impl.wizard Provides classes that can be displayed in the Client Project for RuleApps wizard as a nested wizard after the generator and the RuleApp project had been selected.
ilog.rules.studio.res.ui.generator.impl.wizard.page Provides classes that can be displayed in the Client Project for RuleApps wizard.
ilog.rules.studio.ui.dialogs.wizards.templates Contains the classes related to the Rule Studio template-based wizards.
ilog.rules.studio.ui.propertysheet Contains the classes related to the Rule Studio property sheet.
ilog.rules.studio.vocabulary.bom.editor.term Contains classes related to the term editor dialog and its redefinition for localization purposes.
ilog.rules.teamserver.brm Set of interfaces for the Rule Team Server objects.
ilog.rules.teamserver.client Provides an implementation of a Rule Team Server session factory, allowing a user to access Rule Team Server remotely.
ilog.rules.teamserver.model The ilog.rules.teamserver.model package defines the API used to access and control Rule Team Server data and services.
ilog.rules.teamserver.model.permalink Tools for creating permanent links on Rule Team Server data.
ilog.rules.teamserver.model.permissions Classes and interfaces that represent the Rule Team Server permission data and services.
ilog.rules.teamserver.web.beans Contains JSF managed beans.
ilog.rules.teamserver.web.components.property Provides a set of classes used to render the HTML representation of a property in the Rule Team Server web client.
ilog.rules.teamserver.web.components.property.renderers Provides a set of renderer classes used to render the HTML representation of a property in the Rule Team Server web client.
ilog.rules.teamserver.web.model Interface and default implementations of the models on which the Rule Team Server JSF components rely.
ilog.rules.teamserver.web.tree Contains the base classes and interfaces of the JavaServerFaces tree component.
ilog.rules.teamserver.web.tree.impl Contains a default implementation of the JavaServerFaces tree component.
ilog.rules.teamserver.web.tree.impl.ruleexplorer Contains an implementation of the JavaServerFaces tree component for the Rule Explorer component as in Rule Team Server.
ilog.rules.teamserver.web.tree.taglib Contains the definition of the JavaServerFaces tree component.
ilog.rules.teamserver.web.tree.taglib.renderer Contains the renderers of the JavaServerFaces tree component.
ilog.rules.teamserver.web.validator A custom validator can be used to check that the value of a given property obeys to specific constraints
ilog.rules.tools Command-line tools.
ilog.rules.util Provides utility classes.
ilog.rules.util.engine Provides engine configuration and optimization constants.
ilog.rules.util.prefs Allows applications to retrieve preferences and localized messages.
ilog.rules.util.resources Provides the configuration properties for the rule engine.
ilog.rules.vocabulary.model The ilog.rules.vocabulary.verbalization package contains classes and interfaces related to the set of terms and phrases attached to the elements of the Business Object Model (BOM) of a rule project.
ilog.rules.vocabulary.model.bom Contains classes related to the implementation of the vocabulary on top of a Business Object Model.
ilog.rules.vocabulary.model.bom.io Contains classes related to the serialization/deserialization of a IlrBOMVocabulary object.
ilog.rules.vocabulary.model.event Contains classes related to event management in the Vocabulary.
ilog.rules.vocabulary.model.helper Contains classes and interfaces related to vocabulary helpers.
ilog.rules.vocabulary.model.io Contains classes and interfaces related to vocabulary IO.
ilog.rules.vocabulary.verbalization The ilog.rules.vocabulary.verbalization package contains classes used to help in the process of associating terms and phrases to elements of the business object model.
ilog.rules.webservices.client Deprecated.
ilog.rules.webservices.client.binding Deprecated.
ilog.rules.webservices.client.runtime Deprecated.
ilog.rules.webui Provides the API for manipulating and defining Rule Team Server web components.
ilog.rules.webui.dt Provides the API for manipulating and defining Rule Team Server decision table web components.
ilog.rules.webui.dtree Provides the API for manipulating and defining Rule Team Server decision tree web components.
ilog.rules.xml Provides the base classes and interfaces involved in the XML binding process.
ilog.rules.xml.binding Provides the default implementation of the XML binding interface.
ilog.rules.xml.model Contains the XML model class that provides information for the whole schema.
ilog.rules.xml.types Contains the Java classes representing the XSD simple data types.
ilog.rules.xml.util Contains a number of utility interfaces that are useful for parameterizing the XML binding mapping.
ilog.webui.dhtml Provides the API for manipulating and defining web components.
ilog.webui.dhtml.components Provides a set of predefined web components.
ilog.webui.dhtml.components.event Provides the API for events fired by predefined web components.
ilog.webui.dhtml.components.table Provides classes and interfaces for dealing with table components.
ilog.webui.dhtml.components.tree Provides classes and interfaces for dealing with tree components.
ilog.webui.dhtml.event Provides the API for events fired by the web components framework.

 

The APIs listed in this documentation are the only supported JRules APIs - any API (class, interface, method, constructor or member) in an ilog package not explicitly listed in this documentation is subject to change or removal without prior deprecation in any subsequent release (including technical releases) of JRules, and its use in customer code is not supported.

The APIs documented here provide means to automate and extend JRules, and integrate it into your application.

The product has the following modules:

Developers and other technical users in day to day operations use Rule Studio to create and manage rule projects. For technical users, the rule project is typically stored in a source code control repository, and managed using the same in-house methodologies used for Java projects. Developers use Rule Execution Server to validate their application code, and test rules.

The JRules API packages can be organized into the following groups:



ILOG JRules