Rule Execution Server API

com.ibm.rules.engine.ruledef.runtime
Interface Rule

All Superinterfaces:
Serializable

public interface Rule
extends Serializable

A Rule instance includes the name, package, description and properties of a rule. It does not include the rule logic.


Nested Class Summary
static class Rule.Kind
           
 
Field Summary
static int high
           The second highest priority.
static int low
           The second lowest priority.
static int maximum
           The highest priority.
static int minimum
           The lowest priority.
 
Method Summary
 String getDescription()
          Returns the rule description.
 Rule.Kind getKind()
           
 String getName()
          Returns the fully qualified name of the rule.
 String getPackageName()
          Returns the name of the rule package.
 CustomProperties getProperties()
          Returns the properties of this rule.
 List<RuleAction> getRuleActions()
          Returns all action parts of this rules
 String getShortName()
          Returns the short name of the rule.
 

Field Detail

maximum

static final int maximum

The highest priority. The value of this constant is ONE BILLION.

See Also:
Constant Field Values

high

static final int high

The second highest priority. The value of this constant is ONE MILLION.

See Also:
Constant Field Values

low

static final int low

The second lowest priority. The value of this constant is MINUS ONE MILLION.

See Also:
Constant Field Values

minimum

static final int minimum

The lowest priority. The value of this constant is MINUS ONE BILLION.

See Also:
Constant Field Values
Method Detail

getShortName

String getShortName()
Returns the short name of the rule.

Returns:
The short name of the rule.

getName

String getName()
Returns the fully qualified name of the rule.

Returns:
The fully qualified name of the rule.

getPackageName

String getPackageName()
Returns the name of the rule package.

Returns:
The name of the rule package.

getDescription

String getDescription()
Returns the rule description.

Returns:
A text description of the rule.

getProperties

CustomProperties getProperties()
Returns the properties of this rule.

Returns:
The properties of this rule.

getRuleActions

List<RuleAction> getRuleActions()
Returns all action parts of this rules

Returns:
All action parts of this rules

getKind

Rule.Kind getKind()

Rule Execution Server API

© Copyright IBM Corp. 1987, 2013