org.apache.jetspeed.portlet.event
Interface MessageEvent

All Superinterfaces:

Event

public interface MessageEvent

extends Event

A MessageEvent is sent by the portlet container if one portlets send a message to another.

Author:

Thomas F. Boehme

See Also:

PortletMessage, MessageListener, MessageAdapter

Field Summary

static int

MESSAGE_RECEIVED Event identifier indicating that a message has been received.

Method Summary

PortletMessage

getMessage() Returns the message that this event carries.

Methods inherited from interface org.apache.jetspeed.portlet.event.Event

getConfig, getPortlet, getRequest

Field Detail

MESSAGE_RECEIVED

public static final int MESSAGE_RECEIVED

Event identifier indicating that a message has been received.

An event with this id is fired when one portlet (the source) sends a message to another portlet (the target). The target portlet is specified by name.

See Also:

Constant Field Values

Method Detail

getMessage

public PortletMessage getMessage()

Returns the message that this event carries. The message format is entirely open and has to be defined and documented by the source portlet.

Returns:

the portlet message