org.apache.wsrp4j.consumer
Interface PortletWindowSession

All Known Implementing Classes:

GenericPortletWindowSessionImpl

public interface PortletWindowSession

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

Method Summary

MarkupContext	getCachedMarkup() Get the markup context which has been cached.
PortletSession	getPortletSession() Get the portlet session this window session belongs to.
java.lang.String	getWindowID() Get the ID of the portlets window this session belongs to.
void	setWindowID(java.lang.String windowID) Set the ID of the portlets window this sessions belongs to.
void	updateMarkupCache(MarkupContext markupContext) Update the cache which holds the markup context.

Method Detail

getWindowID

public java.lang.String getWindowID()

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

Returns:

The ID of the portlet window.

setWindowID

public void setWindowID(java.lang.String windowID)

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

Parameters:

windowID - The ID of the portlet window.

getCachedMarkup

public 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

public void updateMarkupCache(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.

Parameters:

markupContext - The markup context or null in case the cache should be cleared.

getPortletSession

public PortletSession getPortletSession()

Get the portlet session this window session belongs to.

Returns:

The PortletSession this window session belongs to.