jadex.runtime
Interface IGoalbase

All Superinterfaces:

IElement

public interface IGoalbase

extends IElement

The programmers interface for the goalbase.

Method Summary

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.

Methods inherited from interface jadex.runtime.IElement

getModelElement, getName

Method Detail

getGoal

public IGoal getGoal(String name)

Get a (proprietary) adopted goal by name.

Parameters:

name - The goal name.

Returns:

The goal (if found).

containsGoal

public 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

public 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

public IGoal[] getGoals()

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

Returns:

All goals and subgoals.

createGoal

public 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

public IFilter dispatchTopLevelGoal(IGoal goal)

Dispatch a new top-level goal.

Parameters:

goal - The new goal.

registerGoal

public void registerGoal(IMGoal mgoal)

Register a new goal model.

Parameters:

mgoal - The goal model.

deregisterGoal

public void deregisterGoal(IMGoal mgoal)

Deregister a goal model.

Parameters:

mgoal - The goal model.

registerGoalReference

public void registerGoalReference(IMGoalReference mgoalref)

Register a new goal reference model.

Parameters:

mgoalref - The goal reference model.

deregisterGoalReference

public void deregisterGoalReference(IMGoalReference mgoalref)

Deregister a goal reference model.

Parameters:

mgoalref - The goal reference model.