Package jakarta.portlet
Interface ActionURL
-
- All Superinterfaces:
BaseURL,Mutable,MutableRenderState,PortletURL,RenderState
- All Known Implementing Classes:
ActionURLWrapper
public interface ActionURL extends PortletURL
An action URL is created withMimeResponse.createActionURL(). An action URL is used to trigger an action request.- Since:
- 3.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description MutableActionParametersgetActionParameters()Gets the action parameter values set for this 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.PortletURL
removePublicRenderParameter, setBeanParameter
-
Methods inherited from interface jakarta.portlet.RenderState
getPortletMode, getWindowState
-
-
-
-
Method Detail
-
getActionParameters
MutableActionParameters getActionParameters()
Gets the action parameter values set for this URL.Action parameters are additional portlet parameters added to the URL that extend the state information provided by the render parameters.
Initially the returned object is empty.
Modifying the parameter values encapsulated by the returned object directly modifies the action parameters applied to the URL.
PortletParametersprovides a description of the parameter concept.- Returns:
- a
MutableActionParametersobject representing the action parameters. - See Also:
ActionParameters,MutableActionParameters
-
-