com.prosyst.mprm.admin.rule

Class TriggerElement

java.lang.Object

com.prosyst.mprm.admin.rule.TriggerElement

public final class TriggerElement
extends java.lang.Object

Defines definition of situation that triggers a Rule. The main properties in this definition are: the Rule Fire and the Rule Condition. Rule Fire stands for the initiative to verify a trigger Condition. Such initiatives can be event-driven (reasoning automation), timer-driven (schedule automation) or manual-fires - all these are defined within the TriggerEvent class, part of the TriggerElement. The triggering Condition is verified on initiative by the Fire, and if satisfied - the Rule is 'triggered'.

Method Summary

Modifier and Type	Method and Description
static TriggerElement	create(TriggerEvent fire) Creates TriggerElement with given Fire and no Condition.
static TriggerElement	create(TriggerEvent fire, java.lang.String triggerCondition) Creates TriggerElement with given Fire and trigger Condition.
static TriggerElement	create(TriggerEvent fire, java.lang.String triggerCondition, boolean sync) Creates TriggerElement with given Fire, trigger Condition and explicit sync option defining whether possible triggers of Rule should be executed synchronously, i.e.
TriggerEvent	getFireCondition() Returns the fire definition for this trigger element.
java.lang.String	getTriggerCondition() Returns the trigger Condition for this trigger element.
boolean	isTriggeredActionSync() Tells whether rule processing should be done synchronously in the thread of the firing event.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static TriggerElement create(TriggerEvent fire)

Creates TriggerElement with given Fire and no Condition.

Parameters:

fire - Fire definition.

Returns:

TriggerElement object having supplied Fire definition.

Throws:

java.lang.IllegalArgumentException - if fire supplied parameter is null.

create

public static TriggerElement create(TriggerEvent fire,
                                    java.lang.String triggerCondition)

Creates TriggerElement with given Fire and trigger Condition.

Parameters:

fire - Fire definition.

triggerCondition - trigger condition.

Returns:

TriggerElement object having supplied Fire definition.

Throws:

java.lang.IllegalArgumentException - if fire supplied parameter is null.

create

public static TriggerElement create(TriggerEvent fire,
                                    java.lang.String triggerCondition,
                                    boolean sync)

Creates TriggerElement with given Fire, trigger Condition and explicit sync option defining whether possible triggers of Rule should be executed synchronously, i.e. in the thread of the firing event.

Parameters:

fire - Fire definition.

triggerCondition - trigger condition.

sync - flag stating whether rule processing should be done synchronously in the thread of the firing event.

Returns:

TriggerElement object having supplied Fire definition.

Throws:

java.lang.IllegalArgumentException - if fire supplied parameter is null.

getFireCondition

public TriggerEvent getFireCondition()

Returns the fire definition for this trigger element.

Returns:

fire definition.

getTriggerCondition

public java.lang.String getTriggerCondition()

Returns the trigger Condition for this trigger element.

Returns:

trigger Condition.

isTriggeredActionSync

public boolean isTriggeredActionSync()

Tells whether rule processing should be done synchronously in the thread of the firing event.

Returns:

true if rule processing should be done synchronously in the thread of the firing event, false otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object