org.exoplatform.services.wsrp.consumer
Interface PortletWindowSession

All Known Implementing Classes:

PortletWindowSessionAdapter

public interface PortletWindowSession

The portlet window session is a session which is unique for every window of a portlet instance.

Method Summary

org.exoplatform.services.wsrp.type.MarkupContext	getCachedMarkup() Get the markup context which has been cached.
String	getNavigationalState()
PortletSession	getPortletSession() Get the portlet session this window session belongs to.
String	getWindowID() Get the ID of the portlets window this session belongs to.
void	setNavigationalState(String navigationalState)
void	setWindowID(String windowID) Set the ID of the portlets window this sessions belongs to.
void	updateMarkupCache(org.exoplatform.services.wsrp.type.MarkupContext markupContext) Update the cache which holds the markup context.

Method Detail

getWindowID

String getWindowID()

Get the ID of the portlets window this session belongs to.

Returns:

The ID of the portlet window.

setWindowID

void setWindowID(String windowID)

Set the ID of the portlets window this sessions belongs to.

Parameters:

windowID - The ID of the portlet window.

getCachedMarkup

org.exoplatform.services.wsrp.type.MarkupContext getCachedMarkup()

Get the markup context which has been cached. This might be useful to retrieve the markup which was returned performBlockingInteraction calls in order to save an additional getMarkup call.

Returns:

The cached markup context or null in case the cache is empty.

updateMarkupCache

void updateMarkupCache(org.exoplatform.services.wsrp.type.MarkupContext markupContext)

Update the cache which holds the markup context. This might be useful to store the markup which was returned by performBlockingInteraction calls in order to save an additional getMarkup call. Updateing the cache with a null value clears the markup cache.

getPortletSession

PortletSession getPortletSession()

Get the portlet session this window session belongs to.

Returns:

The PortletSession this window session belongs to.

setNavigationalState

void setNavigationalState(String navigationalState)

getNavigationalState

String getNavigationalState()