com.tibco.cep.kernel.model.rule

Interface Rule

public interface Rule

Runtime rule.

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PRIORITY Default priority of a rule.
static int	MAX_PRIORITY Maximum priority of a rule.
static int	MIN_PRIORITY Minimum priority of a rule.

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Activates the rule.
void	deactivate() Deactivates the rule.
Action[]	getActions() Get the actions of this rule.
Condition[]	getConditions() Get the conditions of this rule.
java.lang.String	getDescription() Gets the description of the rule.
Identifier[]	getIdentifiers() Gets the identifiers from the declaration section of the rule.
java.lang.String	getName() Gets the name of the rule.
int	getPriority() Gets the priority of the rule.
java.lang.String	getUri() Gets the URI of the rule.
boolean	isActive() Tests if the rule is active.
void	setPriority(int priority) Sets the priority of the rule.

Field Detail

MIN_PRIORITY

static final int MIN_PRIORITY

Minimum priority of a rule.

Since:

2.0.0

See Also:

Constant Field Values

MAX_PRIORITY

static final int MAX_PRIORITY

Maximum priority of a rule.

Since:

2.0.0

See Also:

Constant Field Values

DEFAULT_PRIORITY

static final int DEFAULT_PRIORITY

Default priority of a rule.

Since:

2.0.0

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Gets the name of the rule.

Returns:

the name of the rule.

Since:

2.0.0

getUri

java.lang.String getUri()

Gets the URI of the rule.

Returns:

String URI of the rule.

Since:

4.0.0

getDescription

java.lang.String getDescription()

Gets the description of the rule.

Returns:

a String describing this rule.

Since:

2.0.0

isActive

boolean isActive()

Tests if the rule is active.

Returns:

true if the rule is active.

Since:

2.0.0

See Also:

Rule.activate(), Rule.deactivate()

setPriority

void setPriority(int priority)

Sets the priority of the rule.

Parameters:

priority - the priority to set.

Since:

2.0.0

See Also:

Rule.DEFAULT_PRIORITY, Rule.MIN_PRIORITY, Rule.MAX_PRIORITY

getPriority

int getPriority()

Gets the priority of the rule.

Returns:

the priority of the rule

Since:

2.0.0

See Also:

Rule.DEFAULT_PRIORITY, Rule.MIN_PRIORITY, Rule.MAX_PRIORITY

getIdentifiers

Identifier[] getIdentifiers()

Gets the identifiers from the declaration section of the rule.

Returns:

an array of all the Identifier of this rule.

Since:

2.0.0

getConditions

Condition[] getConditions()

Get the conditions of this rule.

Returns:

an array of all the Condition of this rule.

Since:

2.0.0

getActions

Action[] getActions()

Get the actions of this rule.

Returns:

an array of all the Action of this rule.

Since:

2.0.0

activate

void activate()

Activates the rule.

Since:

2.0.0

See Also:

Rule.deactivate(), Rule.isActive()

deactivate

void deactivate()

Deactivates the rule.

Since:

2.0.0

See Also:

Rule.activate(), Rule.isActive()