jadex.model
Interface IMParameterElement

All Superinterfaces:

IMElement, IMReferenceableElement

All Known Subinterfaces:

IMAchieveGoal, IMEvent, IMGoal, IMGoalEvent, IMInternalEvent, IMMaintainGoal, IMMessageEvent, IMMetaGoal, IMPerformGoal, IMPlan, IMQueryGoal

public interface IMParameterElement
extends IMReferenceableElement

The interface for all elements with parameters.

Field Summary

Fields inherited from interface jadex.model.IMReferenceableElement

EXPORTED_FALSE, EXPORTED_SHIELDED, EXPORTED_TRUE

Method Summary

IMParameter	createParameter(String name, Class clazz, String direction, long updaterate, String expression, String mode) Create a new parameter.
IMParameterSet	createParameterSet(String name, Class clazz, String direction, long updaterate, String expression, String mode) Create a new parameter set.
void	deleteParameter(IMParameter parameter) Delete a parameter.
void	deleteParameterSet(IMParameterSet parameterset) Delete a parameter set.
IMParameter[]	getBindingParameters() Get the bindings.
IMParameter	getParameter(String name) Get a parameter by name.
IMParameter[]	getParameters() Get all parameters.
IMParameterSet	getParameterSet(String name) Get a parameter by name.
IMParameterSet[]	getParameterSets() Get all parameter sets.

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

getParameters

IMParameter[] getParameters()

Get all parameters.

Returns:

All parameters.

getParameter

IMParameter getParameter(String name)

Get a parameter by name.

Parameters:

name - The parameter name.

Returns:

The parameter.

createParameter

IMParameter createParameter(String name,
                            Class clazz,
                            String direction,
                            long updaterate,
                            String expression,
                            String mode)

Create a new parameter.

Parameters:

name - The name of the parameter.

clazz - The class for values.

direction - The direction (in/out).

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

expression - The default value expression (if any).

mode - The evaluation mode.

Returns:

The newly created parameter.

deleteParameter

void deleteParameter(IMParameter parameter)

Delete a parameter.

Parameters:

parameter - The parameter to delete.

getParameterSets

IMParameterSet[] getParameterSets()

Get all parameter sets.

Returns:

All parameter sets.

getParameterSet

IMParameterSet getParameterSet(String name)

Get a parameter by name.

Parameters:

name - The parameter name.

Returns:

The parameter expression.

createParameterSet

IMParameterSet createParameterSet(String name,
                                  Class clazz,
                                  String direction,
                                  long updaterate,
                                  String expression,
                                  String mode)

Create a new parameter set.

Parameters:

name - The name of the parameter set.

clazz - The class for values.

direction - The direction (in/out).

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

expression - The default values expression (if any).

mode - The evaluation mode.

Returns:

The newly created parameter set.

deleteParameterSet

void deleteParameterSet(IMParameterSet parameterset)

Delete a parameter set.

Parameters:

parameterset - The parameter set to delete.

getBindingParameters

IMParameter[] getBindingParameters()

Get the bindings.

Returns:

The binding parameters.