javax.portlet

Interface MutableRenderParameters

All Superinterfaces:

Mutable, MutablePortletParameters, PortletParameters, RenderParameters

All Known Implementing Classes:

MutableRenderParametersWrapper

public interface MutableRenderParameters
extends MutablePortletParameters, RenderParameters

Provides methods that allow setting parameters to define a potential future render state.

For example, these methods can be used to set render parameters on a PortletURL object. The modified parameters will be available during requests triggered by the URL.

If the MutableRenderParameters object was retrieved from a response or a URL, changes made will be applied to that response or URL. The modified parameters will be available during subsequent requests as defined by the response or URL object.

RenderState provides a description of the render state. PortletParameters provides a description of the parameter concept.

Since:

3.0

See Also:

RenderState, MutablePortletParameters, RenderParameters

Method Summary

Modifier and Type	Method and Description
void	clearPrivate() Clears all private parameters that are present in the MutableRenderParameters object.
void	clearPublic() Clears all public parameters that are present in the MutableRenderParameters object.

Methods inherited from interface javax.portlet.MutablePortletParameters

add, clear, getNames, removeParameter, set, setValue, setValues

Methods inherited from interface javax.portlet.RenderParameters

clone, isPublic

Methods inherited from interface javax.portlet.PortletParameters

getValue, getValues, isEmpty, size

Method Detail

clearPrivate

void clearPrivate()

Clears all private parameters that are present in the MutableRenderParameters object.

clearPublic

void clearPublic()

Clears all public parameters that are present in the MutableRenderParameters object.