jadex.model
Interface IMParameter

All Superinterfaces:

IMElement, IMReferenceableElement, IMTypedElement

All Known Subinterfaces:

IMPlanParameter

public interface IMParameter
extends IMTypedElement

Interface for parameters.

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.

Fields inherited from interface jadex.model.IMReferenceableElement

EXPORTED_FALSE, EXPORTED_SHIELDED, EXPORTED_TRUE

Method Summary

IMExpression	createBindingOptions(String expression, String mode) Create the binding options for the parameter (i.e. a collection of possible values).
IMExpression	createDefaultValue(String expression, String mode) Create the default value for the parameter.
void	deleteBindingOptions() Delete the binding options of the parameter (i.e. a collection of possible values).
void	deleteDefaultValue() Delete the default value of the parameter.
IMExpression	getBindingOptions() Get the binding options of the parameter (i.e. a collection of possible values).
IMExpression	getDefaultValue() Get the default value of the parameter.
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.IMTypedElement

getClazz, getUpdateRate, isTransient, setClazz, setTransient, setUpdateRate

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

DIRECTION_FIXED

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

static final String DIRECTION_IN

In parameters for parameter elements.

See Also:

Constant Field Values

DIRECTION_OUT

static final String DIRECTION_OUT

Out parameters for parameter elements.

See Also:

Constant Field Values

DIRECTION_INOUT

static final String DIRECTION_INOUT

Inout parameters for parameter elements.

See Also:

Constant Field Values

Method Detail

getDirection

String getDirection()

Get the direction (in/out).

Returns:

The direction of the parameter.

setDirection

void setDirection(String direction)

Set the direction (in/out).

Parameters:

direction - The direction of the parameter.

isOptional

boolean isOptional()

Get the optional flag.

Returns:

True, if a value for this parameter is optional.

setOptional

void setOptional(boolean optional)

Set the optional flag.

Parameters:

optional - True, if a value for this parameter is optional.

getDefaultValue

IMExpression getDefaultValue()

Get the default value of the parameter.

Returns:

The default value expression (if any).

createDefaultValue

IMExpression createDefaultValue(String expression,
                                String mode)

Create the default value for the parameter.

Parameters:

expression - The expression string.

mode - The evaluation mode.

Returns:

The new value expression.

deleteDefaultValue

void deleteDefaultValue()

Delete the default value of the parameter.

getBindingOptions

IMExpression getBindingOptions()

Get the binding options of the parameter (i.e. a collection of possible values).

Returns:

The binding options expression (if any).

createBindingOptions

IMExpression createBindingOptions(String expression,
                                  String mode)

Create the binding options for the parameter (i.e. a collection of possible values).

Parameters:

expression - The expression string.

mode - The evaluation mode.

Returns:

The new value expression.

deleteBindingOptions

void deleteBindingOptions()

Delete the binding options of the parameter (i.e. a collection of possible values).