com.sage.swt.client.ui.builder
Interface CommunicationEngine

All Known Implementing Classes:

DefaultCommunicationEngine

public interface CommunicationEngine

Interface for the engine that gives a UI access to call the server and to do inter-portlet communication.

Method Summary

InterPortletCommunicator	getInterPortletCommunicator(InstanceContext context, java.lang.String portletCommunicationID) Gets the inter-portlet communicator for the specified portlet.
SwtRequestDispatcher	getRequestDispatcher() Gets the server request dispatcher that this engine makes available.
java.util.Map<java.lang.String,Topic>	getTopics() Gets the map of topic IDs to topics created by this engine.
void	init(UIDefinition uiDefinition) Initializes the communication engine (mainly by setting up the inter-portlet communication topics) so that the getters are available afterward.

Method Detail

init

void init(UIDefinition uiDefinition)

Initializes the communication engine (mainly by setting up the inter-portlet communication topics) so that the getters are available afterward.

Parameters:

uiDefinition - The interface for the information common to all instances of the declarative UI definition.

getRequestDispatcher

SwtRequestDispatcher getRequestDispatcher()

Gets the server request dispatcher that this engine makes available.

Returns:

The server request dispatcher that this engine makes available.

getInterPortletCommunicator

InterPortletCommunicator getInterPortletCommunicator(InstanceContext context,
                                                     java.lang.String portletCommunicationID)

Gets the inter-portlet communicator for the specified portlet.

Parameters:

context - Per-instance context of a UI or popup form. Feature modules interact with the instance context.

portletCommunicationID - The communication ID of the specified portlet (in other words, the portlet ID of its instance context).

Returns:

The inter-portlet communicator for the specified portlet.

getTopics

java.util.Map<java.lang.String,Topic> getTopics()

Gets the map of topic IDs to topics created by this engine.

Returns:

The map of topic IDs to topics created by this engine.