jadex.runtime
Interface IGoal

All Superinterfaces:

IElement, IParameterElement

public interface IGoal

extends IParameterElement

The supertype for all goals (concrete and referenced) and all goal types (perform, achieve, get, maintain).

Field Summary

static Object	EXCLUDE_NEVER Never exclude plan candidates from apl.
static Object	EXCLUDE_WHEN_FAILED Exclude failed plan candidates from apl.
static Object	EXCLUDE_WHEN_SUCCEEDED Exclude succeeded plan candidates from apl.
static Object	EXCLUDE_WHEN_TRIED Exclude tried plan candidates from apl.
static String	LIFECYCLESTATE_ACTIVE The lifecycle state "active" (adopted and processed or monitored).
static String	LIFECYCLESTATE_ADOPTED The lifecycle state "adopted" (adopted, but not active).
static String	LIFECYCLESTATE_DROPPED The lifecycle state "dropped" (deleted).
static String	LIFECYCLESTATE_NEW The lifecycle state "new" (just created).
static String	LIFECYCLESTATE_OPTION The lifecycle state "option" (adopted, but not active).
static String	LIFECYCLESTATE_SUSPENDED The lifecycle state "active" (adopted and processed or monitored).

Method Summary

void	drop() Drop this goal.
String	getExcludeMode() Get the exclude mode.
IFilter	getFilter() Get the filter to wait for an info event.
String	getLifecycleState() Get the lifecycle state.
Object	getResult() Deprecated.
long	getRetryDelay() todo: rename ?!
String	getType() Get the goal type.
boolean	isActive() Get the activation state.
boolean	isAdopted() Check if goal is adopted
boolean	isFailed() Test if a goal is failed.
boolean	isFinished() Test if a goal is finished.
boolean	isMetaLevelReasoning() Get the meta-level-reasoning flag.
boolean	isPostToAll() Get the post-to-all flag.
boolean	isRandomSelection() Get the random selection flag.
boolean	isRetry() Get the retry flag.
boolean	isSucceeded() Test if a goal is succeeded.
void	setExcludeMode(String exclude) Set the exclude mode.
void	setMetaLevelReasoning(boolean flag) Set the meta-level-reasoning flag.
void	setPostToAll(boolean flag) Set the post-to-all flag.
void	setRandomSelection(boolean flag) Set the random selection flag.
void	setResult(Object result) Deprecated.
void	setRetry(boolean flag) Set the retry flag.
void	setRetryDelay(long delay) Set the retry delay (in millis).

Methods inherited from interface jadex.runtime.IParameterElement

getParameter, getParameters, getParameterSet, getParameterSets, hasParameter, hasParameterSet

Methods inherited from interface jadex.runtime.IElement

getModelElement, getName

Field Detail

EXCLUDE_NEVER

public static final Object EXCLUDE_NEVER

Never exclude plan candidates from apl.

EXCLUDE_WHEN_FAILED

public static final Object EXCLUDE_WHEN_FAILED

Exclude failed plan candidates from apl.

EXCLUDE_WHEN_SUCCEEDED

public static final Object EXCLUDE_WHEN_SUCCEEDED

Exclude succeeded plan candidates from apl.

EXCLUDE_WHEN_TRIED

public static final Object EXCLUDE_WHEN_TRIED

Exclude tried plan candidates from apl.

LIFECYCLESTATE_NEW

public static final String LIFECYCLESTATE_NEW

The lifecycle state "new" (just created).

See Also:

Constant Field Values

LIFECYCLESTATE_ADOPTED

public static final String LIFECYCLESTATE_ADOPTED

The lifecycle state "adopted" (adopted, but not active).

See Also:

Constant Field Values

LIFECYCLESTATE_OPTION

public static final String LIFECYCLESTATE_OPTION

The lifecycle state "option" (adopted, but not active).

See Also:

Constant Field Values

LIFECYCLESTATE_ACTIVE

public static final String LIFECYCLESTATE_ACTIVE

The lifecycle state "active" (adopted and processed or monitored).

See Also:

Constant Field Values

LIFECYCLESTATE_SUSPENDED

public static final String LIFECYCLESTATE_SUSPENDED

The lifecycle state "active" (adopted and processed or monitored).

See Also:

Constant Field Values

LIFECYCLESTATE_DROPPED

public static final String LIFECYCLESTATE_DROPPED

The lifecycle state "dropped" (deleted).

See Also:

Constant Field Values

Method Detail

isPostToAll

public boolean isPostToAll()

Get the post-to-all flag.

isMetaLevelReasoning

public boolean isMetaLevelReasoning()

Get the meta-level-reasoning flag.

isRandomSelection

public boolean isRandomSelection()

Get the random selection flag.

setPostToAll

public void setPostToAll(boolean flag)

Set the post-to-all flag.

Parameters:

flag - The post-to-all flag.

setMetaLevelReasoning

public void setMetaLevelReasoning(boolean flag)

Set the meta-level-reasoning flag.

Parameters:

flag - The meta-level-reasoning flag.

setRandomSelection

public void setRandomSelection(boolean flag)

Set the random selection flag.

Parameters:

flag - The random selection flag.

isRetry

public boolean isRetry()

Get the retry flag.

getRetryDelay

public long getRetryDelay()

todo: rename ?! Get the retry delay expression (if any).

getExcludeMode

public String getExcludeMode()

Get the exclude mode.

Returns:

The exclude mode.

setRetry

public void setRetry(boolean flag)

Set the retry flag.

Parameters:

flag - The retry flag.

setRetryDelay

public void setRetryDelay(long delay)

Set the retry delay (in millis).

Parameters:

delay - The delay.

setExcludeMode

public void setExcludeMode(String exclude)

Set the exclude mode.

Parameters:

exclude - The exclude mode.

isActive

public boolean isActive()

Get the activation state.

Returns:

True, if the goal is active.

isAdopted

public boolean isAdopted()

Check if goal is adopted

Returns:

True, if the goal is adopted.

getLifecycleState

public String getLifecycleState()

Get the lifecycle state.

Returns:

The current lifecycle state (e.g. new, active, dropped).

isFinished

public boolean isFinished()

Test if a goal is finished.

Returns:

True, if goal is finished.

isSucceeded

public boolean isSucceeded()

Test if a goal is succeeded. This has different meanings for the different goal types.

Returns:

True, if goal is succeeded.

isFailed

public boolean isFailed()

Test if a goal is failed. This has different meanings for the different goal types.

Returns:

True, if goal has failed.

drop

public void drop()

Drop this goal. Causes all associated process goals and subgoals to be dropped.

getType

public String getType()

Get the goal type.

Returns:

The goal type.

setResult

public void setResult(Object result)

Deprecated.

Set the result for the goal. This is a convenience method, as the goal result is stored as property.

Parameters:

result - The result.

getResult

public Object getResult()

Deprecated.

Get the result of the goal. This is a convenience method, as the goal result is stored as property.

Returns:

The result value.

getFilter

public IFilter getFilter()

Get the filter to wait for an info event.

Returns:

The filter.