com.bowstreet.methods.adapters.events
Interface MessageManager

public interface MessageManager

Interface used to create and send portlet messages.

Field Summary

static java.lang.String	DEFAULT_MESSAGE_EVENT
static java.lang.String	EVENT_NAME_FIELD
static java.lang.String	GET_TITLE_EVENT
static java.lang.String	MESSAGE_FIELD
static java.lang.String	MESSAGE_MANAGER_PARM
static java.lang.String	WINDOW_CLOSED_EVENT
static java.lang.String	WINDOW_CLOSING_EVENT
static java.lang.String	WINDOW_DETACHED_EVENT
static java.lang.String	WINDOW_MAXIMIZED_EVENT
static java.lang.String	WINDOW_MINIMIZED_EVENT
static java.lang.String	WINDOW_RESTORED_EVENT

Method Summary

void	sendDefaultPortletMessage(java.lang.String portletName, java.lang.String message) Sends a DefaultPortletMessage to the specified portlet(s).
void	sendDefaultPortletMessage(java.lang.String portletName, java.lang.String eventName, java.lang.String message) Sends a DefaultPortletMessage to the specified portlet(s).
void	sendWebAppPortletMessage(java.lang.String portletName, java.lang.String eventName, java.lang.Object[] args) Sends a WebAppPortletMessage to the specified portlet(s).

Field Detail

DEFAULT_MESSAGE_EVENT

static final java.lang.String DEFAULT_MESSAGE_EVENT

See Also:

Constant Field Values

EVENT_NAME_FIELD

static final java.lang.String EVENT_NAME_FIELD

See Also:

Constant Field Values

GET_TITLE_EVENT

static final java.lang.String GET_TITLE_EVENT

See Also:

Constant Field Values

MESSAGE_FIELD

static final java.lang.String MESSAGE_FIELD

See Also:

Constant Field Values

MESSAGE_MANAGER_PARM

static final java.lang.String MESSAGE_MANAGER_PARM

See Also:

Constant Field Values

WINDOW_CLOSED_EVENT

static final java.lang.String WINDOW_CLOSED_EVENT

See Also:

Constant Field Values

WINDOW_CLOSING_EVENT

static final java.lang.String WINDOW_CLOSING_EVENT

See Also:

Constant Field Values

WINDOW_DETACHED_EVENT

static final java.lang.String WINDOW_DETACHED_EVENT

See Also:

Constant Field Values

WINDOW_MAXIMIZED_EVENT

static final java.lang.String WINDOW_MAXIMIZED_EVENT

See Also:

Constant Field Values

WINDOW_MINIMIZED_EVENT

static final java.lang.String WINDOW_MINIMIZED_EVENT

See Also:

Constant Field Values

WINDOW_RESTORED_EVENT

static final java.lang.String WINDOW_RESTORED_EVENT

See Also:

Constant Field Values

Method Detail

sendDefaultPortletMessage

void sendDefaultPortletMessage(java.lang.String portletName,
                               java.lang.String message)

Sends a DefaultPortletMessage to the specified portlet(s).

Parameters:

portletName - The name of the portlet(s) to receive the message. null to broadcast to all portlets on the Portals on the current page.

message - The message to send.

sendDefaultPortletMessage

void sendDefaultPortletMessage(java.lang.String portletName,
                               java.lang.String eventName,
                               java.lang.String message)

Sends a DefaultPortletMessage to the specified portlet(s). This will encode the eventName & the message into the text value of the DefaultPortletMessage. Example of encoded text: "EventName:MyAction Message:data sent to event handler"

Parameters:

portletName - The name of the portlet(s) to receive the message. null to broadcast to all portlets on the Portals on the current page.

eventName - The name of the event in a model to fire.

message - The message to send.

sendWebAppPortletMessage

void sendWebAppPortletMessage(java.lang.String portletName,
                              java.lang.String eventName,
                              java.lang.Object[] args)

Sends a WebAppPortletMessage to the specified portlet(s).

Parameters:

portletName - The name of the portlet(s) to receive the message. null to broadcast to all WebApp portlets on the Portals on the current page.

eventName - The name of the event in a model to fire.

args - The arguments to pass on to the event handler action (method).