Package com.appiancorp.suiteapi.process.events

Class Rule

java.lang.Object

com.appiancorp.suiteapi.process.events.Rule

All Implemented Interfaces:

Serializable

public class Rule
extends Object
implements Serializable

Represents a single condition in the set of conditions on an event trigger. Not to be confused with a content rule, which is a stored expression usable within other expressions throughout the application. An event trigger condition (rule) must evaluate to a boolean.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Long	COMPLEX_RULE	Type code for a complex rule (can be any expression).
static final Long	SIMPLE_RULE	Type code for a simple rule (consists of left operand, operator, and right operand).

Constructor Summary

Constructors

Constructor	Description
Rule()

Method Summary

Modifier and Type	Method	Description
String	getExpression()	Gets the expression, which should evaluate to a boolean.
String	getLeftOperand()	Gets the left operand in a simple rule.
String	getOperator()	Gets the operator in a simple rule.
String	getRightOperand()	Gets the right operand in a simple rule.
Long	getType()	Gets the type of the rule (either SIMPLE_RULE or COMPLEX_RULE).
void	setExpression(String expression_)	Sets the expression, which should evaluate to a boolean.
void	setLeftOperand(String leftOperand_)	Sets the left operand in a simple rule.
void	setOperator(String operator_)	Sets the operator in a simple rule.
void	setRightOperand(String rightOperand_)	Sets the right operand in a simple rule.
void	setType(Long type_)	Sets the type of the rule (either SIMPLE_RULE or COMPLEX_RULE).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SIMPLE_RULE

public static final Long SIMPLE_RULE

Type code for a simple rule (consists of left operand, operator, and right operand). This displays in the modeler as two text fields and a dropdown in the middle for the operand. This is called a "Condition" in the modeler (e.g., the button to add this says "Add Condition").

COMPLEX_RULE

public static final Long COMPLEX_RULE

Type code for a complex rule (can be any expression). This displays in the modeler as a single text field.

Constructor Details

Rule

public Rule()

Method Details

getExpression

public String getExpression()

Gets the expression, which should evaluate to a boolean. Only applicable if getType() returns COMPLEX_RULE. Otherwise, this will return null.

Returns:

the expression

See Also:

• setExpression(String)

setExpression

public void setExpression(String expression_)

Sets the expression, which should evaluate to a boolean. Only applicable if getType() returns COMPLEX_RULE.

Parameters:

expression_ - the expression

See Also:

• getExpression()

getLeftOperand

public String getLeftOperand()

Gets the left operand in a simple rule. Only applicable if getType() returns SIMPLE_RULE. Otherwise, this will return null.

Returns:

the left operand

See Also:

• setLeftOperand(String)

setLeftOperand

public void setLeftOperand(String leftOperand_)

Sets the left operand in a simple rule. Only applicable if getType() returns SIMPLE_RULE.

Parameters:

leftOperand_ - the left operand

See Also:

• getLeftOperand()

getOperator

public String getOperator()

Gets the operator in a simple rule. Only applicable if getType() returns SIMPLE_RULE. Otherwise, this will return null.

Returns:

the left operand

See Also:

• setOperator(String)

setOperator

public void setOperator(String operator_)

Sets the operator in a simple rule. Only applicable if getType() returns SIMPLE_RULE.

Parameters:

operator_ - the operator

See Also:

• getOperator()

getRightOperand

public String getRightOperand()

Gets the right operand in a simple rule. Only applicable if getType() returns SIMPLE_RULE. Otherwise, this will return null.

Returns:

the right operand

See Also:

• setRightOperand(String)

setRightOperand

public void setRightOperand(String rightOperand_)

Sets the right operand in a simple rule. Only applicable if getType() returns SIMPLE_RULE.

Parameters:

rightOperand_ - the right operand

See Also:

• getRightOperand()

getType

public Long getType()

Gets the type of the rule (either SIMPLE_RULE or COMPLEX_RULE).

Returns:

the type

See Also:

• setType(Long)

setType

public void setType(Long type_)

Sets the type of the rule (either SIMPLE_RULE or COMPLEX_RULE).

Parameters:

type_ - the type

See Also:

• getType()