jadex.model
Interface IMGoal

All Superinterfaces:

IMElement, IMParameterElement, IMReferenceableElement

All Known Subinterfaces:

IMAchieveGoal, IMMaintainGoal, IMMetaGoal, IMPerformGoal, IMQueryGoal

public interface IMGoal

extends IMParameterElement

The base model element for all goal types.

Field Summary

static String	EXCLUDE_NEVER Never exclude plan candidates from apl.
static String	EXCLUDE_WHEN_FAILED Exclude failed plan candidates from apl.
static String	EXCLUDE_WHEN_SUCCEEDED Exclude succeeded plan candidates from apl.
static String	EXCLUDE_WHEN_TRIED Exclude tried plan candidates from apl.

Method Summary

IMCondition	createContextCondition(String expression) Create a context condition for the goal.
IMCondition	createCreationCondition(String expression) Create a creation condition for the goal.
IMDeliberation	createDeliberation(int cardinality) Create new the deliberation properties for the goal.
IMCondition	createDropCondition(String expression) Create a drop condition for the goal.
IMUnique	createUnique() Create new the uniqueness properties for the goal.
void	deleteContextCondition() Delete the context condition of the goal.
void	deleteCreationCondition() Delete the creation condition of the goal.
void	deleteDeliberation() Delete the deliberation properties of the goal.
void	deleteDropCondition() Delete the drop condition of the goal.
void	deleteUnique() Delete the uniqueness properties of the goal.
IMCondition	getContextCondition() Get the context condition of the goal.
IMCondition	getCreationCondition() Get the creation condition of the goal.
IMDeliberation	getDeliberation() Get the deliberation properties of the goal (if any).
IMCondition	getDropCondition() Get the drop condition of the goal.
String	getExcludeMode() Get the exclude mode.
IMGoalEvent	getGoalEvent() Get the goal event.
IMMetaGoal	getMetaGoal() Get the meta-level goal if any.
IMParameter[]	getRelevantParameters() Get the parameters which are relevant for comparing goals.
IMParameterSet[]	getRelevantParameterSets() Get the parameter sets which are relevant for comparing goals.
long	getRetryDelay() Get the retry delay.
IMUnique	getUnique() Get the uniqueness properties of the goal (if any).
boolean	isMetaLevelReasoning() Get the meta-level reasoning flag.
boolean	isPostToAll() Get the post-to-all flag.
boolean	isRandomSelection() Get the random selection flag.
boolean	isRetry() Get the retry flag.
void	setExcludeMode(String exclude) Set the exclude mode.
void	setMetaGoal(IMMetaGoal metagoal) Set the meta-level goal if any.
void	setMetaLevelReasoning(boolean mlreasoning) Set the meta-level lreasoning flag.
void	setPostToAll(boolean posttoall) Set the post-to-all flag.
void	setRandomSelection(boolean randomselection) Set the random selection flag.
void	setRetry(boolean retry) Set the retry flag.
void	setRetryDelay(long retrydelay) Set the retry delay flag.

Methods inherited from interface jadex.model.IMParameterElement

createParameter, createParameterSet, deleteParameter, deleteParameterSet, getBindingParameters, getParameter, getParameters, getParameterSet, getParameterSets

Methods inherited from interface jadex.model.IMReferenceableElement

createAssignTo, deleteAssignTo, getAssignToElements, getAssignTos, isExported, setExported

Methods inherited from interface jadex.model.IMElement

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

Field Detail

EXCLUDE_NEVER

public static final String EXCLUDE_NEVER

Never exclude plan candidates from apl.

See Also:

Constant Field Values

EXCLUDE_WHEN_FAILED

public static final String EXCLUDE_WHEN_FAILED

Exclude failed plan candidates from apl.

See Also:

Constant Field Values

EXCLUDE_WHEN_SUCCEEDED

public static final String EXCLUDE_WHEN_SUCCEEDED

Exclude succeeded plan candidates from apl.

See Also:

Constant Field Values

EXCLUDE_WHEN_TRIED

public static final String EXCLUDE_WHEN_TRIED

Exclude tried plan candidates from apl.

See Also:

Constant Field Values

Method Detail

getCreationCondition

public IMCondition getCreationCondition()

Get the creation condition of the goal.

Returns:

The creation condition (if any).

createCreationCondition

public IMCondition createCreationCondition(String expression)

Create a creation condition for the goal.

Parameters:

expression - The expression string.

Returns:

The new creation condition.

deleteCreationCondition

public void deleteCreationCondition()

Delete the creation condition of the goal.

getContextCondition

public IMCondition getContextCondition()

Get the context condition of the goal.

Returns:

The context condition (if any).

createContextCondition

public IMCondition createContextCondition(String expression)

Create a context condition for the goal.

Parameters:

expression - The expression string.

Returns:

The new context condition.

deleteContextCondition

public void deleteContextCondition()

Delete the context condition of the goal.

getDropCondition

public IMCondition getDropCondition()

Get the drop condition of the goal.

Returns:

The drop condition (if any).

createDropCondition

public IMCondition createDropCondition(String expression)

Create a drop condition for the goal.

Parameters:

expression - The expression string.

Returns:

The new drop condition.

deleteDropCondition

public void deleteDropCondition()

Delete the drop condition of the goal.

getUnique

public IMUnique getUnique()

Get the uniqueness properties of the goal (if any).

Returns:

The uniqueness properties.

createUnique

public IMUnique createUnique()

Create new the uniqueness properties for the goal.

Returns:

The uniqueness properties.

deleteUnique

public void deleteUnique()

Delete the uniqueness properties of the goal.

getDeliberation

public IMDeliberation getDeliberation()

Get the deliberation properties of the goal (if any).

Returns:

The deliberation properties.

createDeliberation

public IMDeliberation createDeliberation(int cardinality)

Create new the deliberation properties for the goal.

Parameters:

cardinality - The cardinality (i.e. number of concurrently active goals) of this type.

Returns:

The deliberation properties.

deleteDeliberation

public void deleteDeliberation()

Delete the deliberation properties of the goal.

isRetry

public boolean isRetry()

Get the retry flag.

Returns:

The flag indicating if this goal should be retried when the first plan fails.

setRetry

public void setRetry(boolean retry)

Set the retry flag.

Parameters:

retry - The flag indicating if this goal should be retried when the first plan fails.

getRetryDelay

public long getRetryDelay()

Get the retry delay.

Returns:

The delay between retries of the goal (in milliseconds) or -1 for no delay.

setRetryDelay

public void setRetryDelay(long retrydelay)

Set the retry delay flag.

Parameters:

retrydelay - The delay between retries of the goal (in milliseconds) or -1 for no delay.

getExcludeMode

public String getExcludeMode()

Get the exclude mode.

Returns:

The mode indicating which plans should be excluded after they have been tried.

setExcludeMode

public void setExcludeMode(String exclude)

Set the exclude mode.

Parameters:

exclude - The mode indicating which plans should be excluded after they have been tried.

isMetaLevelReasoning

public boolean isMetaLevelReasoning()

Get the meta-level reasoning flag.

Returns:

The flag indicating if meta-level reasoning should be used to select plans for this goal.

setMetaLevelReasoning

public void setMetaLevelReasoning(boolean mlreasoning)

Set the meta-level lreasoning flag.

Parameters:

mlreasoning - The flag indicating if meta-level reasoning should be used to select plans for this goal.

isRandomSelection

public boolean isRandomSelection()

Get the random selection flag.

Returns:

The flag indicating if plans should be selected at random or by prominence.

setRandomSelection

public void setRandomSelection(boolean randomselection)

Set the random selection flag.

Parameters:

randomselection - The flag indicating if plans should be selected at random or by prominence.

isPostToAll

public boolean isPostToAll()

Get the post-to-all flag.

Returns:

The flag indicating if all applicable plans should be executed at once.

setPostToAll

public void setPostToAll(boolean posttoall)

Set the post-to-all flag.

Parameters:

posttoall - The flag indicating if all applicable plans should be executed at once.

getGoalEvent

public IMGoalEvent getGoalEvent()

Get the goal event.

getRelevantParameters

public IMParameter[] getRelevantParameters()

Get the parameters which are relevant for comparing goals.

getRelevantParameterSets

public IMParameterSet[] getRelevantParameterSets()

Get the parameter sets which are relevant for comparing goals.

getMetaGoal

public IMMetaGoal getMetaGoal()

Get the meta-level goal if any.

Returns:

The meta-level goal.

setMetaGoal

public void setMetaGoal(IMMetaGoal metagoal)

Set the meta-level goal if any.

Parameters:

metagoal - The meta-level goal.