jadex.model
Interface IMParameterSet

All Superinterfaces:

IMElement, IMReferenceableElement, IMTypedElementSet

All Known Subinterfaces:

IMPlanParameterSet

public interface IMParameterSet

extends IMTypedElementSet

The parameter set behaviour interface.

Field Summary

static String	DIRECTION_FIXED Fixed values are not allowed to be changed and are used for matching messages.
static String	DIRECTION_IN In parameters for parameter elements.
static String	DIRECTION_INOUT Inout parameters for parameter elements.
static String	DIRECTION_OUT Out parameters for parameter elements.

Method Summary

IMExpression	createDefaultValue(String expression) Create a default values for the parameter.
IMExpression	createDefaultValuesExpression(String expression, String mode) Create the default values expression for the parameter (returning a collection of default values).
void	deleteDefaultValue(IMExpression value) Delete the default values of the parameter.
void	deleteDefaultValuesExpression() Delete the default values expression of the parameter (returning a collection of default values).
IMExpression[]	getDefaultValues() Get the default values of the parameter.
IMExpression	getDefaultValuesExpression() Get the default values expression of the parameter (returning a collection of default values).
String	getDirection() Get the direction (in/out).
boolean	isOptional() Get the optional flag.
void	setDirection(String direction) Set the direction (in/out).
void	setOptional(boolean optional) Set the optional flag.

Methods inherited from interface jadex.model.IMTypedElementSet

getClazz, getUpdateRate, isTransient, setClazz, setTransient, setUpdateRate

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

DIRECTION_FIXED

public static final String DIRECTION_FIXED

Fixed values are not allowed to be changed and are used for matching messages.

See Also:

Constant Field Values

DIRECTION_IN

public static final String DIRECTION_IN

In parameters for parameter elements.

See Also:

Constant Field Values

DIRECTION_OUT

public static final String DIRECTION_OUT

Out parameters for parameter elements.

See Also:

Constant Field Values

DIRECTION_INOUT

public static final String DIRECTION_INOUT

Inout parameters for parameter elements.

See Also:

Constant Field Values

Method Detail

getDirection

public String getDirection()

Get the direction (in/out).

Returns:

The direction of the parameter set.

setDirection

public void setDirection(String direction)

Set the direction (in/out).

Parameters:

direction - The direction of the parameter set.

isOptional

public boolean isOptional()

Get the optional flag.

Returns:

True, if values for this parameter set are optional.

setOptional

public void setOptional(boolean optional)

Set the optional flag.

Parameters:

optional - True, if values for this parameter set are optional.

getDefaultValues

public IMExpression[] getDefaultValues()

Get the default values of the parameter.

Returns:

The default values.

createDefaultValue

public IMExpression createDefaultValue(String expression)

Create a default values for the parameter.

Parameters:

expression - The expression string.

Returns:

The new value expression.

deleteDefaultValue

public void deleteDefaultValue(IMExpression value)

Delete the default values of the parameter.

Parameters:

value - The value expression.

getDefaultValuesExpression

public IMExpression getDefaultValuesExpression()

Get the default values expression of the parameter (returning a collection of default values).

Returns:

The default values expression expression (if any).

createDefaultValuesExpression

public IMExpression createDefaultValuesExpression(String expression,
                                                  String mode)

Create the default values expression for the parameter (returning a collection of default values).

Parameters:

expression - The expression string.

mode - The evaluation mode.

Returns:

The new value expression.

deleteDefaultValuesExpression

public void deleteDefaultValuesExpression()

Delete the default values expression of the parameter (returning a collection of default values).