org.jboss.portal.server.theme.strategy
Interface StrategyResponse

All Known Implementing Classes:

StrategyResponseImpl

public interface StrategyResponse

TODO: A description of this class.

Method Summary

void	addNoRender(PortletContext portlet) Add a portlet to the list of portlets that are excluded from the render process.
void	addWindowStateChange(PortletContext portlet, WindowState state) Add a portlet to the list of portlets that received a new window state by the strategy.
java.util.List	getExcludedList() Get the list of portlets (portlet context) that should not be rendered by the portlet container.
java.lang.String	getLayoutURI() Get the URI of the layout to use, if the layout needs to be changed, otherwise this call will return null.
java.util.List	getModifiedPortletContextList() Get the list of portlet contexts that have been modified.
java.lang.String	getState()
java.util.Map	getWindowStateChangeMap() Get the map of portlet that should change their window state, with the new state in the value
void	reset() Reset all the state of this response
void	setState(java.lang.String state)
void	setURI(java.lang.String layoutURI) Set the layout URI to use

Method Detail

getLayoutURI

java.lang.String getLayoutURI()

Get the URI of the layout to use, if the layout needs to be changed, otherwise this call will return null. Note: this URI can only be one of the layout uris defined in the layout of this request

Returns:

the URI of the layout to delegate to

See Also:

PortalLayout

getWindowStateChangeMap

java.util.Map getWindowStateChangeMap()

Get the map of portlet that should change their window state, with the new state in the value

Returns:

a map of portlets with changed window states (key: portlet context: value: window state)

See Also:

PortletContext, WindowState

getExcludedList

java.util.List getExcludedList()

Get the list of portlets (portlet context) that should not be rendered by the portlet container.

Returns:

the list of portlets that should not be rendered

See Also:

PortletContext

getModifiedPortletContextList

java.util.List getModifiedPortletContextList()

Get the list of portlet contexts that have been modified.

The portlet Context allows to change the region and order of the portlet in that region. If the strategy alters any of those values, it must propagate the change via this list.

Returns:

a java.util.List of org.jboss.portal.core.theme.strategy.PortletContext

addNoRender

void addNoRender(PortletContext portlet)

Add a portlet to the list of portlets that are excluded from the render process.

Parameters:

portlet - the portlet to exclude

addWindowStateChange

void addWindowStateChange(PortletContext portlet,
                          WindowState state)

Add a portlet to the list of portlets that received a new window state by the strategy.

Parameters:

portlet - the portlet that got the new window state

state - the new window state

reset

void reset()

Reset all the state of this response

setURI

void setURI(java.lang.String layoutURI)

Set the layout URI to use

Parameters:

layoutURI - the layout URI to use

setState

void setState(java.lang.String state)

Parameters:

state -

getState

java.lang.String getState()

Returns: