jadex.model
Interface IMPlan

All Superinterfaces:

IMElement, IMParameterElement, IMReferenceableElement

public interface IMPlan
extends IMParameterElement

Model element of a plan.

Field Summary

Fields inherited from interface jadex.model.IMReferenceableElement

EXPORTED_FALSE, EXPORTED_SHIELDED, EXPORTED_TRUE

Method Summary

IMPlanBody	createBody(String expression, String type) Create the body expression.
IMCondition	createContextCondition(String expression) Create a context condition for the plan.
IMPlanParameter	createPlanParameter(String name, Class clazz, String direction, long updaterate, String expression, String mode, String[] ies, String[] mes, String[] goals) Create a new plan parameter.
IMExpression	createPrecondition(String expression) Create a precondition for the plan.
IMPlanTrigger	createTrigger() Create new the trigger for the plan.
IMTrigger	createWaitqueue() Create new the waitqueue for the plan.
void	deleteBody() Delete the plan body expression.
void	deleteContextCondition() Delete the context condition of the plan.
void	deletePrecondition() Delete the precondition of the plan.
void	deleteTrigger() Delete the trigger of the plan.
void	deleteWaitqueue() Delete the waitqueue of the plan.
IMPlanBody	getBody() Get the body expression.
IMCondition	getContextCondition() Get the context condition of the plan.
IMExpression	getPrecondition() Get the precondition of the plan.
int	getPriority() Get the plan priotity.
IMPlanTrigger	getTrigger() Get the trigger of the plan (if any).
IMTrigger	getWaitqueue() Get the waitqueue of the plan (if any).
void	setPriority(int priority) Set the plan priotity.

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

Method Detail

getPriority

int getPriority()

Get the plan priotity.

Returns:

The priority used when selecting this plan.

setPriority

void setPriority(int priority)

Set the plan priotity.

Parameters:

priority - The priority used when selecting this plan.

getBody

IMPlanBody getBody()

Get the body expression.

Returns:

The plan body expression.

createBody

IMPlanBody createBody(String expression,
                      String type)

Create the body expression.

Parameters:

expression - The expression string.

type - The plan body type.

Returns:

The new plan body expression.

deleteBody

void deleteBody()

Delete the plan body expression.

getTrigger

IMPlanTrigger getTrigger()

Get the trigger of the plan (if any).

Returns:

The trigger.

createTrigger

IMPlanTrigger createTrigger()

Create new the trigger for the plan.

Returns:

The trigger.

deleteTrigger

void deleteTrigger()

Delete the trigger of the plan.

getWaitqueue

IMTrigger getWaitqueue()

Get the waitqueue of the plan (if any).

Returns:

The waitqueue.

createWaitqueue

IMTrigger createWaitqueue()

Create new the waitqueue for the plan.

Returns:

The waitqueue.

deleteWaitqueue

void deleteWaitqueue()

Delete the waitqueue of the plan.

getPrecondition

IMExpression getPrecondition()

Get the precondition of the plan.

Returns:

The precondition (if any).

createPrecondition

IMExpression createPrecondition(String expression)

Create a precondition for the plan.

Parameters:

expression - The expression string.

Returns:

The new precondition.

deletePrecondition

void deletePrecondition()

Delete the precondition of the plan.

getContextCondition

IMCondition getContextCondition()

Get the context condition of the plan.

Returns:

The context condition (if any).

createContextCondition

IMCondition createContextCondition(String expression)

Create a context condition for the plan.

Parameters:

expression - The expression string.

Returns:

The new context condition.

deleteContextCondition

void deleteContextCondition()

Delete the context condition of the plan.

createPlanParameter

IMPlanParameter createPlanParameter(String name,
                                    Class clazz,
                                    String direction,
                                    long updaterate,
                                    String expression,
                                    String mode,
                                    String[] ies,
                                    String[] mes,
                                    String[] goals)

Create a new plan parameter.

Parameters:

name - The name of the parameter.

clazz - The class for values.

updaterate - The updaterate (or -1 for none).

expression - The default value expression (if any).

mode - The evaluation mode.

ies - The internal event parameter mappings.

mes - The message event parameter mappings.

goals - The goal parameter mappings.

Returns:

The newly created plan parameter.