jadex.model
Interface IMMessageEvent

All Superinterfaces:

IMElement, IMEvent, IMParameterElement, IMReferenceableElement

public interface IMMessageEvent
extends IMEvent

Interface for message events.

Field Summary

static String	DIRECTION_RECEIVE Describing a message event that can be received.
static String	DIRECTION_SEND Describing a message event that can be send.
static String	DIRECTION_SEND_RECEIVE Describing a message event that can be send and received.

Fields inherited from interface jadex.model.IMReferenceableElement

EXPORTED_FALSE, EXPORTED_SHIELDED, EXPORTED_TRUE

Method Summary

IMExpression	createMatchExpression(String match) Create a new parameter.
void	deleteMatchExpression() Delete a parameter.
IMParameter[]	getDeclaredParameters() Get the user defined parameters.
IMParameterSet[]	getDeclaredParameterSets() Get the user defined parameter sets.
String	getDirection() Get the direction (send/receive).
IMExpression	getMatchExpression() Get the parameters.
MessageType	getMessageType() Get the message type object.
int	getSpecializationDegree() Get the specialization degree.
String	getType() Get the message type (e.g.
void	setDirection(String direction) Set the direction (send/receive).
void	setType(String type) Set the message type (e.g.

Methods inherited from interface jadex.model.IMEvent

isPostToAll, isRandomSelection, setPostToAll, setRandomSelection

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

DIRECTION_RECEIVE

static final String DIRECTION_RECEIVE

Describing a message event that can be received.

See Also:

Constant Field Values

DIRECTION_SEND

static final String DIRECTION_SEND

Describing a message event that can be send.

See Also:

Constant Field Values

DIRECTION_SEND_RECEIVE

static final String DIRECTION_SEND_RECEIVE

Describing a message event that can be send and received.

See Also:

Constant Field Values

Method Detail

getDirection

String getDirection()

Get the direction (send/receive).

Returns:

The direction of the message.

setDirection

void setDirection(String direction)

Set the direction (send/receive).

Parameters:

direction - The direction of the message.

getType

String getType()

Get the message type (e.g. "fipa").

Returns:

The type of the message.

setType

void setType(String type)

Set the message type (e.g. "fipa").

Parameters:

type - The type of the message.

getMatchExpression

IMExpression getMatchExpression()

Get the parameters.

Returns:

The parameters.

createMatchExpression

IMExpression createMatchExpression(String match)

Create a new parameter.

Parameters:

match - The match expression.

Returns:

The newly created match expression.

deleteMatchExpression

void deleteMatchExpression()

Delete a parameter.

getSpecializationDegree

int getSpecializationDegree()

Get the specialization degree.

getMessageType

MessageType getMessageType()

Get the message type object.

Returns:

The type specification object of the message.

getDeclaredParameters

IMParameter[] getDeclaredParameters()

Get the user defined parameters. Does not return the additional type parameters.

Returns:

All declared parameters.

getDeclaredParameterSets

IMParameterSet[] getDeclaredParameterSets()

Get the user defined parameter sets. Does not return the additional type parameter sets.

Returns:

All declared parameter sets.