IRule (Step Enterprise 3.21.0 API)

All Superinterfaces:

com4j.Com4jObject

All Known Subinterfaces:

IRule2
```
public interface IRule
extends com4j.Com4jObject
```
Represents a rule for generating an alert.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`description()`	The rule description.
`int`	`id()`	The rule ID.
`boolean`	`isActive()`	Indicates if the rule is active.
`void`	`isActive(boolean pVal)`	Indicates if the rule is active.
`void`	`post()`	Saves the changes to the Rules object to the server.
`boolean`	`toMail()`	Indicates if the alert is to be sent by e-mail.
`void`	`toMail(boolean pVal)`	Indicates if the alert is to be sent by e-mail.

Methods inherited from interface com4j.Com4jObject
advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

- Method Detail
  - id
```
int id()
```
    The rule ID.
    
    Getter method for the COM property "ID"
    
    Returns:
    
    Returns a value of type int
  - isActive
```
boolean isActive()
```
    Indicates if the rule is active.
    
    Getter method for the COM property "IsActive"
    
    Returns:
    
    Returns a value of type boolean
  - isActive
```
void isActive(boolean pVal)
```
    Indicates if the rule is active.
    
    Setter method for the COM property "IsActive"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - toMail
```
boolean toMail()
```
    Indicates if the alert is to be sent by e-mail.
    
    Getter method for the COM property "ToMail"
    
    Returns:
    
    Returns a value of type boolean
  - toMail
```
void toMail(boolean pVal)
```
    Indicates if the alert is to be sent by e-mail.
    
    Setter method for the COM property "ToMail"
    
    Parameters:
    
    pVal - Mandatory boolean parameter.
  - description
```
String description()
```
    The rule description.
    
    Getter method for the COM property "Description"
    
    Returns:
    
    Returns a value of type java.lang.String
  - post
```
void post()
```
    Saves the changes to the Rules object to the server.