jadex.runtime
Interface ICondition

All Superinterfaces:

IElement, IExpression

public interface ICondition
extends IExpression

Common interface for all conditions

Field Summary

static String	TRACE_ALWAYS Always trace this condition (generate event whenever satisfied).
static String	TRACE_NEVER Do not trace this condition (the default).
static String	TRACE_ONCE Trace this condition once (until satisfied).
static String	TRIGGER_ALWAYS Trigger on every evaluation regardless of state.
static String	TRIGGER_CHANGES Trigger when the state changes.
static String	TRIGGER_CHANGES_TO_FALSE Trigger when the state changes to false.
static String	TRIGGER_CHANGES_TO_TRUE Trigger when the state changes to true.
static String	TRIGGER_IS_FALSE Trigger when the state is to false.
static String	TRIGGER_IS_TRUE Trigger when the state is to true.

Method Summary

void	addConditionListener(IConditionListener listener, boolean async) Add a condition listener.
IFilter	getFilter() Get the filter to wait for the condition.
String	getTraceMode() Get the trace mode.
void	removeConditionListener(IConditionListener listener) Remove a condition listener.
void	setTraceMode(String trace) Set the trace mode without generating events immediately.
void	traceAlways() Trace this condition always, generating an event whenever it evaluates to true.
void	traceOnce() Trace this condition once, until it is triggerd.

Methods inherited from interface jadex.runtime.IExpression

execute, execute, execute, getParameter, getValue, refresh, setParameter

Methods inherited from interface jadex.runtime.IElement

getModelElement, getName

Field Detail

TRACE_NEVER

static final String TRACE_NEVER

Do not trace this condition (the default).

See Also:

Constant Field Values

TRACE_ALWAYS

static final String TRACE_ALWAYS

Always trace this condition (generate event whenever satisfied).

See Also:

Constant Field Values

TRACE_ONCE

static final String TRACE_ONCE

Trace this condition once (until satisfied).

See Also:

Constant Field Values

TRIGGER_ALWAYS

static final String TRIGGER_ALWAYS

Trigger on every evaluation regardless of state.

See Also:

Constant Field Values

TRIGGER_CHANGES

static final String TRIGGER_CHANGES

Trigger when the state changes.

See Also:

Constant Field Values

TRIGGER_CHANGES_TO_FALSE

static final String TRIGGER_CHANGES_TO_FALSE

Trigger when the state changes to false.

See Also:

Constant Field Values

TRIGGER_CHANGES_TO_TRUE

static final String TRIGGER_CHANGES_TO_TRUE

Trigger when the state changes to true.

See Also:

Constant Field Values

TRIGGER_IS_FALSE

static final String TRIGGER_IS_FALSE

Trigger when the state is to false.

See Also:

Constant Field Values

TRIGGER_IS_TRUE

static final String TRIGGER_IS_TRUE

Trigger when the state is to true.

See Also:

Constant Field Values

Method Detail

getTraceMode

String getTraceMode()

Get the trace mode.

setTraceMode

void setTraceMode(String trace)

Set the trace mode without generating events immediately.

Parameters:

trace - The new trace mode.

traceOnce

void traceOnce()

Trace this condition once, until it is triggerd. If the condition is now true, an event is immediately generated.

traceAlways

void traceAlways()

Trace this condition always, generating an event whenever it evaluates to true. If the condition is now true, an event is immediately generated.

getFilter

IFilter getFilter()

Get the filter to wait for the condition.

Returns:

The filter.

addConditionListener

void addConditionListener(IConditionListener listener,
                          boolean async)

Add a condition listener.

Parameters:

listener - The condition listener.

async - True, if the notification should be done on a separate thread.

removeConditionListener

void removeConditionListener(IConditionListener listener)

Remove a condition listener.

Parameters:

listener - The condition listener.