jadex.runtime
Interface IMessageEvent

All Superinterfaces:

IElement, IEvent, IParameterElement

public interface IMessageEvent
extends IEvent

The interface for all message events (concrete and referenced).

Method Summary

void	addMessageEventListener(IMessageEventListener listener, boolean async) Add a message event listener.
IMessageEvent	createReply(String type) Create a reply to this message event.
IMessageEvent	createReply(String type, Object content) Create a reply to this message event.
Object	getContent() Get the content.
IFilter	getFilter() Get the filter to wait for a reply.
Object	getMessage() Get the native (platform specific) message object.
void	removeMessageEventListener(IMessageEventListener listener) Remove a message event listener.
void	setContent(Object content) Set the content.

Methods inherited from interface jadex.runtime.IEvent

getType, isPostToAll, isRandomSelection

Methods inherited from interface jadex.runtime.IParameterElement

getParameter, getParameters, getParameterSet, getParameterSets, hasParameter, hasParameterSet

Methods inherited from interface jadex.runtime.IElement

getModelElement, getName

Method Detail

getMessage

Object getMessage()

Get the native (platform specific) message object.

getContent

Object getContent()

Get the content. Allowed content objects depend on the platform.

Returns:

The content.

setContent

void setContent(Object content)

Set the content. Allowed content objects depend on the platform.

Parameters:

content - The content.

createReply

IMessageEvent createReply(String type)

Create a reply to this message event.

Parameters:

type - The reply message event type (defined in the ADF).

Returns:

The reply event.

createReply

IMessageEvent createReply(String type,
                          Object content)

Create a reply to this message event.

Parameters:

type - The reply message event type (defined in the ADF).

content - The message content.

Returns:

The reply event.

getFilter

IFilter getFilter()

Get the filter to wait for a reply.

Returns:

The filter.

addMessageEventListener

void addMessageEventListener(IMessageEventListener listener,
                             boolean async)

Add a message event listener.

Parameters:

listener - The message event listener.

removeMessageEventListener

void removeMessageEventListener(IMessageEventListener listener)

Remove a message event listener.

Parameters:

listener - The message event listener.