org.apache.jetspeed.portlet.event
Interface MessageEvent

All Superinterfaces:

Event

Deprecated. since 6.0. Support of the IBM portlet API may be removed in a future release of WebSphere Portal. Use of the Java Portlet API (javax.portlet) is recommended instead.

public interface MessageEvent
extends Event

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

If applicable, portlet programmers should use Property Broker or Click-to-Action instead of this low-level message passing facility

Since:

4.1

See Also:

PortletMessage, MessageListener

Field Summary

static int

MESSAGE_RECEIVED Deprecated. Event identifier indicating that a message has been received.

Method Summary

PortletMessage

getMessage() Deprecated. Returns the message that this event carries.

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

getPortlet, getRequest

Field Detail

MESSAGE_RECEIVED

static final int MESSAGE_RECEIVED

Deprecated.

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

PortletMessage getMessage()

Deprecated.

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