org.jasig.portal.portlet.om
Interface IPortletWindow

All Superinterfaces:

org.apache.pluto.PortletWindow, Serializable

public interface IPortletWindow
extends org.apache.pluto.PortletWindow, Serializable

uPortal extensions to the Pluto PortletWindow interface. A portlet window represents the actual rendering/interaction layer of the portlet object model.

Version:

$Revision$

Author:

Eric Dalquist

Method Summary

IPortletWindowId	getDelegationParent()
Integer	getExpirationCache()
IPortletEntityId	getPortletEntityId()
IPortletWindowId	getPortletWindowId() Retrieve this windows unique id which will be used to communicate back to the referencing portal.
Map<String,List<String>>	getRequestParameters()
void	setExpirationCache(Integer expirationCache) Sets the expiration timeout for the portlet rendering cache.
void	setPortletMode(PortletMode mode)
void	setRequestParameters(Map<String,List<String>> requestParameters)
void	setWindowState(WindowState state)

Methods inherited from interface org.apache.pluto.PortletWindow

getContextPath, getId, getPortletMode, getPortletName, getWindowState

Method Detail

getPortletWindowId

IPortletWindowId getPortletWindowId()

Retrieve this windows unique id which will be used to communicate back to the referencing portal.

Returns:

unique id.

getPortletEntityId

IPortletEntityId getPortletEntityId()

Returns:

The ID of the parent portlet entity.

setWindowState

void setWindowState(WindowState state)

Parameters:

state - The current WindowState of this PortletWindow

Throws:

IllegalArgumentException - If state is null

setPortletMode

void setPortletMode(PortletMode mode)

Parameters:

mode - The current PortletMode of this PortletWindow

Throws:

IllegalArgumentException - If mode is null

setRequestParameters

void setRequestParameters(Map<String,List<String>> requestParameters)

Parameters:

requestParameters - The current request parameters for the portlet

Throws:

IllegalArgumentException - if parameters is null.

getRequestParameters

Map<String,List<String>> getRequestParameters()

Returns:

The current request parameters for the portlet

setExpirationCache

void setExpirationCache(Integer expirationCache)

Sets the expiration timeout for the portlet rendering cache. If null is set the timeout configured in the portlet.xml should be used.

Parameters:

expirationCache - Set the cache expiration length for the portlet in seconds.

getExpirationCache

Integer getExpirationCache()

Returns:

The expiration timeout for the portlet, if null the value from portlet.xml should be used.

getDelegationParent

IPortletWindowId getDelegationParent()

Returns:

The ID of the parent portlet window that is delegating rendering to this portlet, null if this portlet is not being delegated to.