org.gatein.wsrp.api.context

Interface ConsumerStructureProvider

public interface ConsumerStructureProvider

Provides a way to interact with the structure of the portal in which the WSRP consumer is running. This is needed for the import/export functionality. The structure of a portal is understood to be as follows: several uniquely identifiable pages containing windows, which are supposed to be uniquely identifiable within the context of the containing page. Each window displays a portlet which can be re-assigned so that the window displays the content of the new portlet.

Version:

$Revision$

Author:

Chris Laprun

Method Summary

Methods

Modifier and Type	Method and Description
void	assignPortletToWindow(org.gatein.pc.api.PortletContext portletContext, String windowId, String pageId, String portletTitle) Re-assigns the window identified by the specified window identifier in the specified page to display the portlet identified by the specified portlet context, potentially using the specified title.
List<String>	getPageIdentifiers() Retrieves the list of page identifiers.
List<String>	getWindowIdentifiersFor(String pageId) Retrieves the list of identifiers for the windows that are contained within the page identified by the specified identifier.

Method Detail

getPageIdentifiers

List<String> getPageIdentifiers()

Retrieves the list of page identifiers.

Returns:

the list of page identifiers.

getWindowIdentifiersFor

List<String> getWindowIdentifiersFor(String pageId)

Retrieves the list of identifiers for the windows that are contained within the page identified by the specified identifier.

Parameters:

pageId - the page identifier for which we want to retrieve windows

Returns:

the list of identifiers of windows contained within the specified page

assignPortletToWindow

void assignPortletToWindow(org.gatein.pc.api.PortletContext portletContext,
                         String windowId,
                         String pageId,
                         String portletTitle)

Re-assigns the window identified by the specified window identifier in the specified page to display the portlet identified by the specified portlet context, potentially using the specified title. Note that the title is only an indication for the portal to use to display on the window if it is implemented this way.

Parameters:

portletContext - the PortletContext identifying which portlet needs to be displayed

windowId - the window identifier of the window which will display the new portlet

pageId - the page identifier of the page which contains the window to re-assign

portletTitle - a portlet title to potentially use on the window decoration