public interface PortletURL extends BaseURL, MutableRenderState
PortletURL
interface represents a URL
that reference the portlet itself.
A PortletURL is created through the RenderResponse
or ResourceResponse
.
Parameters, a portlet mode, a window state and a security level
can be added to PortletURL
objects.
There are two types of PortletURLs:
createActionURL
, and
trigger an action request followed by a render request.
createRenderURL
, and
trigger a render request.
The string representation of a PortletURL does not need to be a valid URL at the time the portlet is generating its content. It may contain special tokens that will be converted to a valid URL, by the portal, before the content is returned to the client.
Modifier and Type | Method and Description |
---|---|
void |
removePublicRenderParameter(String name)
Deprecated.
As of version 3.0. Use
RenderState.getRenderParameters() instead. |
void |
setBeanParameter(PortletSerializable bean)
Sets the value of a @RenderStateScoped bean
on an action or render URL.
|
addProperty, append, append, getParameterMap, setParameter, setParameter, setParameters, setProperty, setSecure, toString, write, write
getRenderParameters, setPortletMode, setWindowState
getPortletMode, getWindowState
@Deprecated void removePublicRenderParameter(String name)
RenderState.getRenderParameters()
instead.public-render-parameter
element with the
identifier
mapping to the parameter name.name
- a String
specifying
the name of the public render parameter to be removedIllegalArgumentException
- if name is null
.void setBeanParameter(PortletSerializable bean)
bean
- The @RenderStateScoped beanIllegalArgumentException
- if the bean is not an @RenderStateScoped bean.RenderStateScoped
Java Portlet 3.0 API Specification. See the Copyright and License provided with this distribution. Use is subject to license terms.