StateAwareResponse represents a response that can modify
render state information or send events.
If the render state is modified through this interface, the changes take effect for subsequent portlet render phase processing.
RenderState, PortletResponse
| Modifier and Type | Method and Description |
|---|---|
| public Map | Returns: Map containing render parameter names as keys and
parameter values as map values, or an empty Map if
no parameters exist. The keys in the parameter map are of type
String. The values in the parameter map are of type String array (String[]).
Deprecated
As of version 3.0. Use
Returns a getRenderParameters() instead.
Map of the render parameters currently set on
this response.
|
| public void | removePublicRenderParameter(String
a name)String specifying
the name of the public render parameter to be removed
Deprecated
As of version 3.0. Use
Removes the specified public render parameter.
getRenderParameters() instead.
|
| public void | setEvent(QName
the event name to publish, must not be name, Serializable nullthe value of this event, must have a valid JAXB binding and
be serializable, or value)null.Publishes an Event with the given payload. |
| public void | setEvent(String
the local part of the event name to publish, must not be name, Serializable nullthe value of this event, must have a valid JAXB binding and
be serializable, or value)null.Publishes an Event with the given payload in the default namespace. |
| public void | setRenderParameter(String
key of the render parameter key, String value of the render parameter value)
Deprecated
As of version 3.0. Use
Sets
a String parameter for the render request.
getRenderParameters() instead.
|
| public void | setRenderParameter(String
key of the render parameter key, String... values of the render parameter values)
Deprecated
As of version 3.0. Use
Sets
a multi-valued String parameter for the render request.
getRenderParameters() instead.
|
| public void | setRenderParameters(Map<String, String[]>
Map containing parameter names for the render phase as keys and
parameter values as map values. The keys in the parameter map must be of type
String and may not be null or the empty string (""). The values in the parameter
map must be of type String array ( parameters)String[]).
The values array may not be null;
however, the values array elements may be null.
Deprecated
As of version 3.0. Use
Sets
a parameter map for the render request.
getRenderParameters() instead.
|
| getRenderParameterMap | back to summary |
|---|---|
| public Map Deprecated As of version 3.0. Use Returns a
The values in the returned
The contents of the returned map are immutable in the sense that modifying the map does not directly
affect the render parameters. In order to set the parameters using the modified map,
the
If no parameters exist this method returns an empty | |
| removePublicRenderParameter | back to summary |
|---|---|
| public void removePublicRenderParameter(String name)
Deprecated As of version 3.0. Use Removes the specified public render parameter.
The name must reference a public render parameter defined
in the portlet deployment descriptor under the
| |
| setEvent | back to summary |
|---|---|
| public void setEvent(QName name, Serializable value) Publishes an Event with the given payload. The object type of the value must be compliant with the specified event type in the portlet deployment descriptor. The value must have a valid JAXB binding and be serializable.
| |
| setEvent | back to summary |
|---|---|
| public void setEvent(String name, Serializable value) Publishes an Event with the given payload in the default namespace.
The name is treated as local part of the event QName and the namespace
is either taken from the The object type of the value must be compliant with the specified event type in the portlet deployment descriptor. The value must have a valid JAXB binding and be serializable.
| |
| setRenderParameter | back to summary |
|---|---|
| public void setRenderParameter(String key, String value)
Deprecated As of version 3.0. Use Sets a String parameter for the render request. These parameters will be accessible in all subsequent render calls until an action or render request is targeted to the portlet. This method replaces all parameters with the given key. The given parameter do not need to be encoded prior to calling this method.
A parameter value of
| |
| setRenderParameter | back to summary |
|---|---|
| public void setRenderParameter(String key, String... values)
Deprecated As of version 3.0. Use Sets a multi-valued String parameter for the render request. These parameters will be accessible in all subsequent render calls until an action or render request is targeted to the portlet. This method replaces all parameter values with the given key. The given parameter do not need to be encoded prior to calling this method.
A values parameter of If the values parameter is not null, elements of the array may be null.
| |
| setRenderParameters | back to summary |
|---|---|
| public void setRenderParameters(Map<String, String[]> parameters)
Deprecated As of version 3.0. Use Sets a parameter map for the render request.
These parameters will be accessible in all sub-sequent render calls via
the The given parameters do not need to be encoded prior to calling this method. The portlet should not modify the map any further after calling this method. This method can be used to set both public and private render parameters. These parameters will be accessible in all subsequent render calls via the PortletRequest.getParameter call until a new request is targeted to the portlet. Any previously set private render parameter that is not contained in the new map is removed. However, public render parameters cannot be removed by excluding them from the map. Public render parameters that are not included in the map remain unchanged. The given parameters do not need to be encoded prior to calling this method. The portlet should not modify the map any further after calling this method.
| |