org.jasig.portal.portlet.url
Interface IPortletRequestParameterManager

All Known Implementing Classes:

PortletRequestParameterManager

public interface IPortletRequestParameterManager

Provides access to portlet specific information for a HttpServletRequest.

Version:

$Revision$

Author:

Eric Dalquist

Method Summary

PortletUrl	getPortletRequestInfo(HttpServletRequest request, IPortletWindowId portletWindowId) Gets the request information for the specified portlet, returns null if the specified portlet was not targeted.
IPortletWindowId	getTargetedPortletWindowId(HttpServletRequest request) Gets the portlet window ID targeted by the request, returns null if no portlet was targeted.
void	setAdditionalPortletUrl(HttpServletRequest request, PortletUrl portletUrl) Set the PortletUrl for portlets that have data in this request but are not targeted
void	setTargetedPortletUrl(HttpServletRequest request, PortletUrl portletUrl) Set the PortletUrl for the portlet that is targeted by the request

Method Detail

setTargetedPortletUrl

void setTargetedPortletUrl(HttpServletRequest request,
                           PortletUrl portletUrl)

Set the PortletUrl for the portlet that is targeted by the request

Parameters:

request - The current request.

portletUrl - The PortletUrl for the targeted portlet, null if no portlet was targeted for the request

Throws:

IllegalArgumentException - If request or is null.

setAdditionalPortletUrl

void setAdditionalPortletUrl(HttpServletRequest request,
                             PortletUrl portletUrl)

Set the PortletUrl for portlets that have data in this request but are not targeted

Parameters:

request - The current request

portletUrl - The PortletUrl for the additional portlet

Throws:

IllegalArgumentException - If request or portletUrl are null.

getTargetedPortletWindowId

IPortletWindowId getTargetedPortletWindowId(HttpServletRequest request)

Gets the portlet window ID targeted by the request, returns null if no portlet was targeted.

Parameters:

request - The current request.

Returns:

The IPortletWindowId of the portlet targeted by the request, null if no portlet was targeted.

Throws:

IllegalArgumentException - If request is null

RequestParameterProcessingIncompleteException - If this request doesn't have the necessary information associated with it yet to return the set

getPortletRequestInfo

PortletUrl getPortletRequestInfo(HttpServletRequest request,
                                 IPortletWindowId portletWindowId)

Gets the request information for the specified portlet, returns null if the specified portlet was not targeted.

Parameters:

request - The current request.

portletWindowId - The id of the portlet to get request information for

Returns:

The PortletUrl for the specified IPortletWindowId, null if the specified portlet was not targeted.

Throws:

IllegalArgumentException - If request is null

RequestParameterProcessingIncompleteException - If this request doesn't have the necessary information associated with it yet to return a request type