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.

Fields inherited from interface jadex.model.IMReferenceableElement

EXPORTED_FALSE, EXPORTED_SHIELDED, EXPORTED_TRUE

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.
long	getRecurDelay() Get the recur delay.
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	isPostToAll() Get the post-to-all flag.
boolean	isRandomSelection() Get the random selection flag.
boolean	isRecalculating() Get the recalculate applicable candidates list (apl) state.
boolean	isRecur() Get the recur flag.
boolean	isRetry() Get the retry flag.
void	setExcludeMode(String exclude) Set the exclude mode.
void	setPostToAll(boolean posttoall) Set the post-to-all flag.
void	setRandomSelection(boolean randomselection) Set the random selection flag.
void	setRecalculating(boolean recalculate) Set the recalculate applicable candidates list (apl) state.
void	setRecur(boolean recur) Set the recur flag.
void	setRecurDelay(long recurdelay) Set the recur delay 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, getExported, setExported

Methods inherited from interface jadex.model.IMElement

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

Field Detail

EXCLUDE_NEVER

static final String EXCLUDE_NEVER

Never exclude plan candidates from apl.

See Also:

Constant Field Values

EXCLUDE_WHEN_FAILED

static final String EXCLUDE_WHEN_FAILED

Exclude failed plan candidates from apl.

See Also:

Constant Field Values

EXCLUDE_WHEN_SUCCEEDED

static final String EXCLUDE_WHEN_SUCCEEDED

Exclude succeeded plan candidates from apl.

See Also:

Constant Field Values

EXCLUDE_WHEN_TRIED

static final String EXCLUDE_WHEN_TRIED

Exclude tried plan candidates from apl.

See Also:

Constant Field Values

Method Detail

getCreationCondition

IMCondition getCreationCondition()

Get the creation condition of the goal.

Returns:

The creation condition (if any).

createCreationCondition

IMCondition createCreationCondition(String expression)

Create a creation condition for the goal.

Parameters:

expression - The expression string.

Returns:

The new creation condition.

deleteCreationCondition

void deleteCreationCondition()

Delete the creation condition of the goal.

getContextCondition

IMCondition getContextCondition()

Get the context condition of the goal.

Returns:

The context condition (if any).

createContextCondition

IMCondition createContextCondition(String expression)

Create a context condition for the goal.

Parameters:

expression - The expression string.

Returns:

The new context condition.

deleteContextCondition

void deleteContextCondition()

Delete the context condition of the goal.

getDropCondition

IMCondition getDropCondition()

Get the drop condition of the goal.

Returns:

The drop condition (if any).

createDropCondition

IMCondition createDropCondition(String expression)

Create a drop condition for the goal.

Parameters:

expression - The expression string.

Returns:

The new drop condition.

deleteDropCondition

void deleteDropCondition()

Delete the drop condition of the goal.

getUnique

IMUnique getUnique()

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

Returns:

The uniqueness properties.

createUnique

IMUnique createUnique()

Create new the uniqueness properties for the goal.

Returns:

The uniqueness properties.

deleteUnique

void deleteUnique()

Delete the uniqueness properties of the goal.

getDeliberation

IMDeliberation getDeliberation()

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

Returns:

The deliberation properties.

createDeliberation

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

void deleteDeliberation()

Delete the deliberation properties of the goal.

isRetry

boolean isRetry()

Get the retry flag.

Returns:

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

setRetry

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

long getRetryDelay()

Get the retry delay.

Returns:

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

setRetryDelay

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

String getExcludeMode()

Get the exclude mode.

Returns:

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

setExcludeMode

void setExcludeMode(String exclude)

Set the exclude mode.

Parameters:

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

isRandomSelection

boolean isRandomSelection()

Get the random selection flag.

Returns:

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

setRandomSelection

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

boolean isPostToAll()

Get the post-to-all flag.

Returns:

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

setPostToAll

void setPostToAll(boolean posttoall)

Set the post-to-all flag.

Parameters:

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

isRecalculating

boolean isRecalculating()

Get the recalculate applicable candidates list (apl) state.

Returns:

True, if should be recalculated eacht time.

setRecalculating

void setRecalculating(boolean recalculate)

Set the recalculate applicable candidates list (apl) state.

Parameters:

recalculate - True, if should be recalculated eacht time.

isRecur

boolean isRecur()

Get the recur flag.

Returns:

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

setRecur

void setRecur(boolean recur)

Set the recur flag.

Parameters:

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

getRecurDelay

long getRecurDelay()

Get the recur delay.

Returns:

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

setRecurDelay

void setRecurDelay(long recurdelay)

Set the recur delay flag.

Parameters:

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

getGoalEvent

IMGoalEvent getGoalEvent()

Get the goal event.

getRelevantParameters

IMParameter[] getRelevantParameters()

Get the parameters which are relevant for comparing goals.

getRelevantParameterSets

IMParameterSet[] getRelevantParameterSets()

Get the parameter sets which are relevant for comparing goals.