Top Description Methods
javax.portlet

public Interface PortletURL

extends BaseURL, MutableRenderState
Known Direct Subinterfaces
javax.portlet.RenderURL, javax.portlet.ActionURL
Known Direct Implementers
javax.portlet.filter.PortletURLWrapper
Imports
javax.portlet.annotations.PortletSerializable

The 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:

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.

Method Summary

Modifier and TypeMethod and Description
public void
removePublicRenderParameter(String
a String specifying the name of the public render parameter to be removed
name
)

Deprecated As of version 3.0. Use getRenderParameters() instead.
Removes the specified public render parameter.
public void
setBeanParameter(PortletSerializable
The @RenderStateScoped bean
bean
)

Sets the value of a @RenderStateScoped bean on an action or render URL.
Inherited from javax.portlet.BaseURL:
addPropertyappendappendgetParameterMapsetParametersetParametersetParameterssetPropertysetSecuretoStringwritewrite
Inherited from javax.portlet.MutableRenderState:
getRenderParameterssetPortletModesetWindowState

Method Detail

removePublicRenderParameterback to summary
public void removePublicRenderParameter(String name)

Deprecated

As of version 3.0. Use getRenderParameters() instead.

Removes the specified public render parameter. The name must reference a public render parameter defined in the portlet deployment descriptor under the public-render-parameter element with the identifier mapping to the parameter name.

Parameters
name:String

a String specifying the name of the public render parameter to be removed

Annotations
@Deprecated
Exceptions
IllegalArgumentException:
if name is null.
Since
2.0
setBeanParameterback to summary
public void setBeanParameter(PortletSerializable bean)

Sets the value of a @RenderStateScoped bean on an action or render URL.

Calling this method copies the bean state to the URL so that the values are available to the portlet when the URL is activated.

Parameters
bean:PortletSerializable

The @RenderStateScoped bean

Exceptions
IllegalArgumentException:
if the bean is not an @RenderStateScoped bean.
Since
3.0
See Also
javax.portlet.annotations.RenderStateScoped