com.caucho.portal.generic
Interface PortalResponse


public interface PortalResponse


Method Summary
 PortalURL createActionURL(java.lang.String namespace, boolean keepParameters)
          Create an action url that targets another namespace.
 PortalURL createRenderURL(java.lang.String namespace, boolean keepParameters)
          Create a render url to another namespace.
 void setParameter(java.lang.String namespace, java.lang.String name, java.lang.String value)
          Set a Rparameter for a namespace.
 void setParameter(java.lang.String namespace, java.lang.String name, java.lang.String[] values)
          Set a parameter for a namespace.
 void setParameters(java.lang.String namespace, java.util.Map<java.lang.String,java.lang.String[]> srcMap)
          Set parameters for a namespace to the map.
 void setPortletMode(java.lang.String namespace, PortletMode portletMode)
          Set the portlet modes for a namespace.
 void setWindowState(java.lang.String namespace, WindowState windowState)
          Set the window state for a namespace.
 

Method Detail

setPortletMode

void setPortletMode(java.lang.String namespace,
                    PortletMode portletMode)
                    throws PortletModeException
Set the portlet modes for a namespace. If the portlet matching the namespace has already had processAction() or render() called on it, an exception is thrown because it is too late to set the portlet mode.

Throws:
PortletModeException

setWindowState

void setWindowState(java.lang.String namespace,
                    WindowState windowState)
                    throws WindowStateException
Set the window state for a namespace. If the portlet matching the namespace has already had processAction() or render() called on it, an exception is thrown because it is too late to set the window state.

Throws:
WindowStateException

setParameters

void setParameters(java.lang.String namespace,
                   java.util.Map<java.lang.String,java.lang.String[]> srcMap)
Set parameters for a namespace to the map. If the portlet matching the namespace has already had processAction() or render() called on it, an exception is thrown because it is too late to set parameters.


setParameter

void setParameter(java.lang.String namespace,
                  java.lang.String name,
                  java.lang.String value)
Set a Rparameter for a namespace. If the portlet matching the namespace has already had processAction() or render() called on it, an exception is thrown because it is too late to set parameters.


setParameter

void setParameter(java.lang.String namespace,
                  java.lang.String name,
                  java.lang.String[] values)
Set a parameter for a namespace. If the portlet matching the namespace has already had processAction() or render() called on it, an exception is thrown because it is too late to set parameters.


createRenderURL

PortalURL createRenderURL(java.lang.String namespace,
                          boolean keepParameters)
Create a render url to another namespace.

Parameters:
keepParameters - if true, then the render parameters that exist for the namespace for this request are maintained for the next request. If false, the url when first formed will have no parameters.

createActionURL

PortalURL createActionURL(java.lang.String namespace,
                          boolean keepParameters)
Create an action url that targets another namespace.

Parameters:
isSticky - if true, then the render parameters that exist for the namespace for this request are maintained for the next request. If false, the url when first formed will have no parameters.