jadex.bdi.runtime

Interface IGoal

All Superinterfaces:

IElement, IParameterElement, IProcessableElement

public interface IGoal
extends IProcessableElement

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addGoalListener(IGoalListener listener) Add a goal listener.
void	drop() Drop this goal.
Exception	getException() Get the exception (if any).
String	getExcludeMode() Get the exclude mode.
String	getLifecycleState() Get the lifecycle state.
long	getRecurDelay() Get the recur delay expression (if any).
long	getRetryDelay() Get the retry delay expression (if any).
boolean	isActive() Get the activation state.
boolean	isAdopted() Check if goal is adopted
boolean	isFinished() Test if a goal is finished.
boolean	isRecur() Get the recur flag.
boolean	isRetry() Get the retry flag.
boolean	isSucceeded() Test if a goal is succeeded.
void	removeGoalListener(IGoalListener listener) Remove a goal listener.

Methods inherited from interface jadex.bdi.runtime.IProcessableElement

isPostToAll, isRandomSelection

Methods inherited from interface jadex.bdi.runtime.IParameterElement

getParameter, getParameters, getParameterSet, getParameterSets, getType, hasParameter, hasParameterSet

Methods inherited from interface jadex.bdi.runtime.IElement

getModelElement

Method Detail

isRetry

boolean isRetry()

Get the retry flag.

getRetryDelay

long getRetryDelay()

Get the retry delay expression (if any).

getExcludeMode

String getExcludeMode()

Get the exclude mode.

Returns:

The exclude mode.

isRecur

boolean isRecur()

Get the recur flag.

getRecurDelay

long getRecurDelay()

Get the recur delay expression (if any).

isActive

boolean isActive()

Get the activation state.

Returns:

True, if the goal is active.

isAdopted

boolean isAdopted()

Check if goal is adopted

Returns:

True, if the goal is adopted.

getLifecycleState

String getLifecycleState()

Get the lifecycle state.

Returns:

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

isFinished

boolean isFinished()

Test if a goal is finished.

Returns:

True, if goal is finished.

isSucceeded

boolean isSucceeded()

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

Returns:

True, if goal is succeeded.

drop

void drop()

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

getException

Exception getException()

Get the exception (if any). When the goal has failed, the exception can be inspected. If more than one plan has been executed for a goal only the last exception will be available.

addGoalListener

void addGoalListener(IGoalListener listener)

Add a goal listener.

Parameters:

listener - The goal listener.

removeGoalListener

void removeGoalListener(IGoalListener listener)

Remove a goal listener.

Parameters:

listener - The goal listener.