jadex.bdi.runtime

Interface IPlan

All Superinterfaces:

IElement, IParameterElement

public interface IPlan
extends IParameterElement

A currently instantiated plan of the agent (=intention).

Field Summary

Fields

Modifier and Type	Field and Description
static String	PLANLIFECYCLESTATE_ABORTED The state, indicating the execution of the aborted.
static String	PLANLIFECYCLESTATE_BODY The state, indicating the execution of the plan body.
static String	PLANLIFECYCLESTATE_FAILED The state, indicating the execution of the failed code.
static String	PLANLIFECYCLESTATE_NEW The lifecycle state "new" (just created).
static String	PLANLIFECYCLESTATE_PASSED The state, indicating the execution of the passed code.

Method Summary

Methods

Modifier and Type	Method and Description
void	abortPlan() Abort a running plan.
void	addPlanListener(IPlanListener listener) Add a goal listener.
Object	getBody() Get the body.
String	getLifecycleState() Get the lifecycle state of the plan (e.g. body or aborted).
IElement	getReason() Get the reason (i.e. initial event).
IWaitqueue	getWaitqueue() Get the waitqueue.
void	removePlanListener(IPlanListener listener) Remove a goal listener.

Methods inherited from interface jadex.bdi.runtime.IParameterElement

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

Methods inherited from interface jadex.bdi.runtime.IElement

getModelElement

Field Detail

PLANLIFECYCLESTATE_NEW

static final String PLANLIFECYCLESTATE_NEW

The lifecycle state "new" (just created).

See Also:

Constant Field Values

PLANLIFECYCLESTATE_BODY

static final String PLANLIFECYCLESTATE_BODY

The state, indicating the execution of the plan body.

See Also:

Constant Field Values

PLANLIFECYCLESTATE_PASSED

static final String PLANLIFECYCLESTATE_PASSED

The state, indicating the execution of the passed code.

See Also:

Constant Field Values

PLANLIFECYCLESTATE_FAILED

static final String PLANLIFECYCLESTATE_FAILED

The state, indicating the execution of the failed code.

See Also:

Constant Field Values

PLANLIFECYCLESTATE_ABORTED

static final String PLANLIFECYCLESTATE_ABORTED

The state, indicating the execution of the aborted.

See Also:

Constant Field Values

Method Detail

getLifecycleState

String getLifecycleState()

Get the lifecycle state of the plan (e.g. body or aborted).

Returns:

The lifecycle state.

getWaitqueue

IWaitqueue getWaitqueue()

Get the waitqueue.

Returns:

The waitqueue.

getBody

Object getBody()

Get the body.

Returns:

The body.

getReason

IElement getReason()

Get the reason (i.e. initial event).

Returns:

The reason.

abortPlan

void abortPlan()

Abort a running plan.

addPlanListener

void addPlanListener(IPlanListener listener)

Add a goal listener.

Parameters:

listener - The goal listener.

removePlanListener

void removePlanListener(IPlanListener listener)

Remove a goal listener.

Parameters:

listener - The goal listener.