jadex.runtime
Interface IGoalbase

All Superinterfaces:

IElement

public interface IGoalbase
extends IElement

The programmers interface for the goalbase. todo: getTopLevelGoals() ?

Method Summary

void	addGoalListener(String type, IGoalListener listener, boolean async) Add a goal listener.
boolean	containsGoal(IGoal goal) Test if an adopted goal is already contained in the goal base.
IGoal	createGoal(String type) Create a goal from a template goal.
void	deregisterGoal(IMGoal mgoal) Deregister a goal model.
void	deregisterGoalReference(IMGoalReference mgoalref) Deregister a goal reference model.
IFilter	dispatchTopLevelGoal(IGoal goal) Dispatch a new top-level goal.
IGoal	getGoal(String name) Get a (proprietary) adopted goal by name.
IGoal[]	getGoals() Get all the adopted goals in this scope (including subgoals).
IGoal[]	getGoals(String type) Get all proprietary goals of a specified type (=model element name).
void	registerGoal(IMGoal mgoal) Register a new goal model.
void	registerGoalReference(IMGoalReference mgoalref) Register a new goal reference model.
void	removeGoalListener(String type, IGoalListener listener) Remove a goal listener.

Methods inherited from interface jadex.runtime.IElement

getModelElement, getName

Method Detail

getGoal

IGoal getGoal(String name)

Get a (proprietary) adopted goal by name.

Parameters:

name - The goal name.

Returns:

The goal (if found).

containsGoal

boolean containsGoal(IGoal goal)

Test if an adopted goal is already contained in the goal base.

Parameters:

goal - The goal to test.

Returns:

True, if the goal is contained.

getGoals

IGoal[] getGoals(String type)

Get all proprietary goals of a specified type (=model element name).

Parameters:

type - The goal type.

Returns:

All proprietary goals of the specified type.

getGoals

IGoal[] getGoals()

Get all the adopted goals in this scope (including subgoals).

Returns:

All goals and subgoals.

createGoal

IGoal createGoal(String type)

Create a goal from a template goal. To be processed, the goal has to be dispatched as subgoal or adopted as top-level goal.

Parameters:

type - The template goal name as specified in the ADF.

Returns:

The created goal.

dispatchTopLevelGoal

IFilter dispatchTopLevelGoal(IGoal goal)

Dispatch a new top-level goal.

Parameters:

goal - The new goal.

registerGoal

void registerGoal(IMGoal mgoal)

Register a new goal model.

Parameters:

mgoal - The goal model.

deregisterGoal

void deregisterGoal(IMGoal mgoal)

Deregister a goal model.

Parameters:

mgoal - The goal model.

registerGoalReference

void registerGoalReference(IMGoalReference mgoalref)

Register a new goal reference model.

Parameters:

mgoalref - The goal reference model.

deregisterGoalReference

void deregisterGoalReference(IMGoalReference mgoalref)

Deregister a goal reference model.

Parameters:

mgoalref - The goal reference model.

addGoalListener

void addGoalListener(String type,
                     IGoalListener listener,
                     boolean async)

Add a goal listener.

Parameters:

type - The goal type.

listener - The goal listener.

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

removeGoalListener

void removeGoalListener(String type,
                        IGoalListener listener)

Remove a goal listener.

Parameters:

type - The goal type.

listener - The goal listener.