PortletURL (Portlet 4.0 API Specification)

All Superinterfaces:

BaseURL, Mutable, MutableRenderState, RenderState

All Known Subinterfaces:

ActionURL, RenderURL

All Known Implementing Classes:

ActionURLWrapper, PortletURLWrapper, RenderURLWrapper
```
public interface PortletURL
extends BaseURL, MutableRenderState
```
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:
- Action URLs, they are created with createActionURL, and trigger an action request followed by a render request.
- Render URLs, they are created with 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.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`removePublicRenderParameter(String name)`	Deprecated. As of version 3.0.
`void`	`setBeanParameter(PortletSerializable bean)`	Sets the value of a @RenderStateScoped bean on an action or render URL.

Methods inherited from interface jakarta.portlet.BaseURL
addProperty, append, append, getParameterMap, setParameter, setParameter, setParameters, setProperty, setSecure, toString, write, write

Methods inherited from interface jakarta.portlet.MutableRenderState
getRenderParameters, setPortletMode, setWindowState

Methods inherited from interface jakarta.portlet.RenderState
getPortletMode, getWindowState

- Method Detail
  - removePublicRenderParameter
```
@Deprecated
void removePublicRenderParameter(String name)
```
    Deprecated.
    As of version 3.0. Use RenderState.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 - a String specifying the name of the public render parameter to be removed
    
    Throws:
    
    IllegalArgumentException - if name is null.
    
    Since:
    
    2.0
  - setBeanParameter
```
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 - The @RenderStateScoped bean
    
    Throws:
    
    IllegalArgumentException - if the bean is not an @RenderStateScoped bean.
    
    Since:
    
    3.0
    
    See Also:
    
    RenderStateScoped