Rule (Rule Designer API)

All Superinterfaces:

java.io.Serializable
```
public interface Rule
extends java.io.Serializable
```
A Rule instance includes the name, package, description and properties of a rule. It does not include the rule logic.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Rule.Kind

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Rule.Kind`

Field Summary

Fields
Modifier and Type	Field and Description
`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

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDescription()` Returns the rule description.
`Rule.Kind`	`getKind()`
`java.lang.String`	`getName()` Returns the fully qualified name of the rule.
`java.lang.String`	`getPackageName()` Returns the name of the rule package.
`CustomProperties`	`getProperties()` Returns the properties of this rule.
`java.util.List<RuleAction>`	`getRuleActions()` Returns all action parts of this rules
`java.lang.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
```
java.lang.String getShortName()
```
    Returns the short name of the rule.
    
    Returns:
    The short name of the rule.
  - getName
```
java.lang.String getName()
```
    Returns the fully qualified name of the rule.
    
    Returns:
    The fully qualified name of the rule.
  - getPackageName
```
java.lang.String getPackageName()
```
    Returns the name of the rule package.
    
    Returns:
    The name of the rule package.
  - getDescription
```
java.lang.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
```
java.util.List<RuleAction> getRuleActions()
```
    Returns all action parts of this rules
    
    Returns:
    All action parts of this rules
  - getKind
```
Rule.Kind getKind()
```

maximum

high

low

minimum

getShortName

getName

getPackageName

getDescription

getProperties

getRuleActions

getKind