jadex.model
Interface IMGoalbase

All Superinterfaces:

IMBase, IMElement

public interface IMGoalbase

extends IMBase

The goalbase behaviour interface.

Field Summary

static String

DUMMY_GOAL The constant for defining the dummy goal.

Method Summary

IMAchieveGoal	createAchieveGoal(String name, boolean exported, boolean retry, long retrydelay, String exclude) Create an achieve goal.
IMAchieveGoalReference	createAchieveGoalReference(String name, boolean exported, String ref) Create an achieve goal reference.
IMMaintainGoal	createMaintainGoal(String name, boolean exported, boolean retry, long retrydelay, String exclude, boolean recur, long recurdelay) Create a maintain goal.
IMMaintainGoalReference	createMaintainGoalReference(String name, boolean exported, String ref) Create an maintain goal reference.
IMMetaGoal	createMetaGoal(String name, boolean exported, boolean retry, long retrydelay, String exclude) Create a meta goal.
IMMetaGoalReference	createMetaGoalReference(String name, boolean exported, String ref) Create a meta goal reference.
IMPerformGoal	createPerformGoal(String name, boolean exported, boolean retry, long retrydelay, String exclude) Create a perform goal.
IMPerformGoalReference	createPerformGoalReference(String name, boolean exported, String ref) Create a perform goal reference.
IMQueryGoal	createQueryGoal(String name, boolean exported, boolean retry, long retrydelay, String exclude) Create a query goal.
IMQueryGoalReference	createQueryGoalReference(String name, boolean exported, String ref) Create a query goal reference.
void	deleteAchieveGoal(IMAchieveGoal goal) Delete an achieve goal.
void	deleteAchieveGoalReference(IMAchieveGoalReference goal) Delete an achieve goal reference.
void	deleteMaintainGoal(IMMaintainGoal goal) Delete a maintain goal.
void	deleteMaintainGoalReference(IMMaintainGoalReference goal) Delete an maintain goal reference.
void	deleteMetaGoal(IMMetaGoal goal) Delete a meta goal.
void	deleteMetaGoalReference(IMMetaGoalReference goal) Delete a meta goal reference.
void	deletePerformGoal(IMPerformGoal goal) Delete a perform goal.
void	deletePerformGoalReference(IMPerformGoalReference goal) Delete a perform goal reference.
void	deleteQueryGoal(IMQueryGoal goal) Delete a query goal.
void	deleteQueryGoalReference(IMQueryGoalReference goal) Delete a query goal reference.
IMAchieveGoal	getAchieveGoal(String name) Get an achieve goal by name.
IMAchieveGoalReference	getAchieveGoalReference(String name) Get an goal by name.
IMAchieveGoalReference[]	getAchieveGoalReferences() Get all known achieve goal references.
IMAchieveGoal[]	getAchieveGoals() Get all known achieve goals.
IMGoal	getGoal(String name) Get a goal by name.
IMGoalReference	getGoalReference(String name) Get a goal reference.
IMGoalReference[]	getGoalReferences() Get all goal references.
IMGoal[]	getGoals() Get all known goals.
IMMaintainGoal	getMaintainGoal(String name) Get a maintain goal by name.
IMMaintainGoalReference	getMaintainGoalReference(String name) Get an goal by name.
IMMaintainGoalReference[]	getMaintainGoalReferences() Get all known maintain goal references.
IMMaintainGoal[]	getMaintainGoals() Get all known maintain goals.
IMMetaGoal	getMetaGoal(String name) Get a meta goal by name.
IMMetaGoalReference	getMetaGoalReference(String name) Get a meta goal by name.
IMMetaGoalReference[]	getMetaGoalReferences() Get all known meta goal references.
IMMetaGoal[]	getMetaGoals() Get all known meta goals.
IMPerformGoal	getPerformGoal(String name) Get a perform goal by name.
IMPerformGoalReference	getPerformGoalReference(String name) Get a goal by name.
IMPerformGoalReference[]	getPerformGoalReferences() Get all known perform goal references.
IMPerformGoal[]	getPerformGoals() Get all known perform goals.
IMQueryGoal	getQueryGoal(String name) Get a query goal by name.
IMQueryGoalReference	getQueryGoalReference(String name) Get a query goal by name.
IMQueryGoalReference[]	getQueryGoalReferences() Get all known query goal references.
IMQueryGoal[]	getQueryGoals() Get all known query goals.

Methods inherited from interface jadex.model.IMBase

deleteReferenceableElement, getCorrespondingBase, getElementReferences, getReferenceableElement, getReferenceableElements

Methods inherited from interface jadex.model.IMElement

check, getChildren, getDescription, getEncodableRepresentation, getExpressionParameters, getName, getOwner, getReport, getScope, setDescription, setName

Field Detail

DUMMY_GOAL

public static final String DUMMY_GOAL

The constant for defining the dummy goal.

See Also:

Constant Field Values

Method Detail

getPerformGoals

public IMPerformGoal[] getPerformGoals()

Get all known perform goals.

Returns:

The perform goals.

getPerformGoal

public IMPerformGoal getPerformGoal(String name)

Get a perform goal by name.

Parameters:

name - The perform goal name.

Returns:

The perform goal with that name (if any).

createPerformGoal

public IMPerformGoal createPerformGoal(String name,
                                       boolean exported,
                                       boolean retry,
                                       long retrydelay,
                                       String exclude)

Create a perform goal.

Parameters:

name - The name of the goal.

exported - Flag indicating if this goal may be referenced from outside capabilities.

retry - Should the goal be retried when not succeeded after the first plan.

retrydelay - An optional delay (in milliseconds) before the next plan is executed (-1 for no delay).

exclude - An optional identifer specifying which plans to exclude after they have been executed.

Returns:

The perform goal.

deletePerformGoal

public void deletePerformGoal(IMPerformGoal goal)

Delete a perform goal.

Parameters:

goal - The perform goal.

getPerformGoalReferences

public IMPerformGoalReference[] getPerformGoalReferences()

Get all known perform goal references.

Returns:

The perform goal references.

getPerformGoalReference

public IMPerformGoalReference getPerformGoalReference(String name)

Get a goal by name.

Parameters:

name - The perform goal reference name.

Returns:

The perform goal reference with that name (if any).

createPerformGoalReference

public IMPerformGoalReference createPerformGoalReference(String name,
                                                         boolean exported,
                                                         String ref)

Create a perform goal reference.

Parameters:

name - The name of the goal reference.

exported - Flag indicating if this goal reference may be referenced from outside capabilities.

ref - The referenced goal (or null for abstract).

Returns:

The perform goal reference.

deletePerformGoalReference

public void deletePerformGoalReference(IMPerformGoalReference goal)

Delete a perform goal reference.

Parameters:

goal - The perform goal reference.

getAchieveGoals

public IMAchieveGoal[] getAchieveGoals()

Get all known achieve goals.

Returns:

The achieve goals.

getAchieveGoal

public IMAchieveGoal getAchieveGoal(String name)

Get an achieve goal by name.

Parameters:

name - The achieve goal name.

Returns:

The achieve goal with that name (if any).

createAchieveGoal

public IMAchieveGoal createAchieveGoal(String name,
                                       boolean exported,
                                       boolean retry,
                                       long retrydelay,
                                       String exclude)

Create an achieve goal.

Parameters:

name - The name of the goal.

exported - Flag indicating if this goal may be referenced from outside capabilities.

retry - Should the goal be retried when not succeeded after the first plan.

retrydelay - An optional delay (in milliseconds) before the next plan is executed (-1 for no delay).

exclude - An optional identifer specifying which plans to exclude after they have been executed.

Returns:

The achieve goal.

deleteAchieveGoal

public void deleteAchieveGoal(IMAchieveGoal goal)

Delete an achieve goal.

Parameters:

goal - The achieve goal.

getAchieveGoalReferences

public IMAchieveGoalReference[] getAchieveGoalReferences()

Get all known achieve goal references.

Returns:

The achieve goal references.

getAchieveGoalReference

public IMAchieveGoalReference getAchieveGoalReference(String name)

Get an goal by name.

Parameters:

name - The achieve goal reference name.

Returns:

The achieve goal reference with that name (if any).

createAchieveGoalReference

public IMAchieveGoalReference createAchieveGoalReference(String name,
                                                         boolean exported,
                                                         String ref)

Create an achieve goal reference.

Parameters:

name - The name of the goal reference.

exported - Flag indicating if this goal reference may be referenced from outside capabilities.

ref - The referenced goal (or null for abstract).

Returns:

The achieve goal reference.

deleteAchieveGoalReference

public void deleteAchieveGoalReference(IMAchieveGoalReference goal)

Delete an achieve goal reference.

Parameters:

goal - The achieve goal reference.

getQueryGoals

public IMQueryGoal[] getQueryGoals()

Get all known query goals.

Returns:

The query goals.

getQueryGoal

public IMQueryGoal getQueryGoal(String name)

Get a query goal by name.

Parameters:

name - The query goal name.

Returns:

The query goal with that name (if any).

createQueryGoal

public IMQueryGoal createQueryGoal(String name,
                                   boolean exported,
                                   boolean retry,
                                   long retrydelay,
                                   String exclude)

Create a query goal.

Parameters:

name - The name of the goal.

exported - Flag indicating if this goal may be referenced from outside capabilities.

retry - Should the goal be retried when not succeeded after the first plan.

retrydelay - An optional delay (in milliseconds) before the next plan is executed (-1 for no delay).

exclude - An optional identifer specifying which plans to exclude after they have been executed.

Returns:

The query goal.

deleteQueryGoal

public void deleteQueryGoal(IMQueryGoal goal)

Delete a query goal.

Parameters:

goal - The query goal.

getQueryGoalReferences

public IMQueryGoalReference[] getQueryGoalReferences()

Get all known query goal references.

Returns:

The query goal references.

getQueryGoalReference

public IMQueryGoalReference getQueryGoalReference(String name)

Get a query goal by name.

Parameters:

name - The query goal reference name.

Returns:

The query goal reference with that name (if any).

createQueryGoalReference

public IMQueryGoalReference createQueryGoalReference(String name,
                                                     boolean exported,
                                                     String ref)

Create a query goal reference.

Parameters:

name - The name of the goal reference.

exported - Flag indicating if this goal reference may be referenced from outside capabilities.

ref - The referenced goal (or null for abstract).

Returns:

The query goal reference.

deleteQueryGoalReference

public void deleteQueryGoalReference(IMQueryGoalReference goal)

Delete a query goal reference.

Parameters:

goal - The query goal reference.

getMaintainGoals

public IMMaintainGoal[] getMaintainGoals()

Get all known maintain goals.

Returns:

The maintain goals.

getMaintainGoal

public IMMaintainGoal getMaintainGoal(String name)

Get a maintain goal by name.

Parameters:

name - The maintain goal name.

Returns:

The maintain goal with that name (if any).

createMaintainGoal

public IMMaintainGoal createMaintainGoal(String name,
                                         boolean exported,
                                         boolean retry,
                                         long retrydelay,
                                         String exclude,
                                         boolean recur,
                                         long recurdelay)

Create a maintain goal.

Parameters:

name - The name of the goal.

exported - Flag indicating if this goal may be referenced from outside capabilities.

retry - Should the goal be retried when not succeeded after the first plan.

retrydelay - An optional delay (in milliseconds) before the next plan is executed (-1 for no delay).

exclude - An optional identifer specifying which plans to exclude after they have been executed.

recur - Should the goal be recurred when not succeeded after all available plans have been tried.

recurdelay - An optional delay (in milliseconds) before the goal is recurred (-1 for no delay).

Returns:

The maintain goal.

deleteMaintainGoal

public void deleteMaintainGoal(IMMaintainGoal goal)

Delete a maintain goal.

Parameters:

goal - The maintain goal.

getMaintainGoalReferences

public IMMaintainGoalReference[] getMaintainGoalReferences()

Get all known maintain goal references.

Returns:

The maintain goal references.

getMaintainGoalReference

public IMMaintainGoalReference getMaintainGoalReference(String name)

Get an goal by name.

Parameters:

name - The maintain goal reference name.

Returns:

The maintain goal reference with that name (if any).

createMaintainGoalReference

public IMMaintainGoalReference createMaintainGoalReference(String name,
                                                           boolean exported,
                                                           String ref)

Create an maintain goal reference.

Parameters:

name - The name of the goal reference.

exported - Flag indicating if this goal reference may be referenced from outside capabilities.

ref - The referenced goal (or null for abstract).

Returns:

The maintain goal reference.

deleteMaintainGoalReference

public void deleteMaintainGoalReference(IMMaintainGoalReference goal)

Delete an maintain goal reference.

Parameters:

goal - The maintain goal reference.

getMetaGoals

public IMMetaGoal[] getMetaGoals()

Get all known meta goals.

Returns:

The meta goals.

getMetaGoal

public IMMetaGoal getMetaGoal(String name)

Get a meta goal by name.

Parameters:

name - The meta goal name.

Returns:

The meta goal with that name (if any).

createMetaGoal

public IMMetaGoal createMetaGoal(String name,
                                 boolean exported,
                                 boolean retry,
                                 long retrydelay,
                                 String exclude)

Create a meta goal.

Parameters:

name - The name of the goal.

exported - Flag indicating if this goal may be referenced from outside capabilities.

retry - Should the goal be retried when not succeeded after the first plan.

retrydelay - An optional delay (in milliseconds) before the next plan is executed (-1 for no delay).

exclude - An optional identifer specifying which plans to exclude after they have been executed.

Returns:

The meta goal.

deleteMetaGoal

public void deleteMetaGoal(IMMetaGoal goal)

Delete a meta goal.

Parameters:

goal - The meta goal.

getMetaGoalReferences

public IMMetaGoalReference[] getMetaGoalReferences()

Get all known meta goal references.

Returns:

The meta goal references.

getMetaGoalReference

public IMMetaGoalReference getMetaGoalReference(String name)

Get a meta goal by name.

Parameters:

name - The meta goal reference name.

Returns:

The meta goal reference with that name (if any).

createMetaGoalReference

public IMMetaGoalReference createMetaGoalReference(String name,
                                                   boolean exported,
                                                   String ref)

Create a meta goal reference.

Parameters:

name - The name of the goal reference.

exported - Flag indicating if this goal reference may be referenced from outside capabilities.

ref - The referenced goal (or null for abstract).

Returns:

The meta goal reference.

deleteMetaGoalReference

public void deleteMetaGoalReference(IMMetaGoalReference goal)

Delete a meta goal reference.

Parameters:

goal - The meta goal reference.

getGoals

public IMGoal[] getGoals()

Get all known goals.

Returns:

The goals.

getGoal

public IMGoal getGoal(String name)

Get a goal by name.

Parameters:

name - The goal name.

Returns:

The goal with that name (if any).

getGoalReferences

public IMGoalReference[] getGoalReferences()

Get all goal references.

Returns:

The goal references.

getGoalReference

public IMGoalReference getGoalReference(String name)

Get a goal reference.

Parameters:

name - The name.

Returns:

The goal reference.