org.jasig.portal.url
Interface IPortalPortletUrl

All Superinterfaces:

IBasePortalUrl

public interface IPortalPortletUrl
extends IBasePortalUrl

Specific type of portal URL that targets a portlet. The URL can have portal parameters and portlet parameters, support for setting the next WindowState and PortletMode for the portlet.

Version:

$Revision: 19776 $

Author:

Eric Dalquist

Method Summary

PortletMode	getPortletMode()
Map<String,List<String>>	getPortletParameters() Get the current portlet parameters.
WindowState	getWindowState()
boolean	isAction()
void	setAction(boolean action)
void	setPortletMode(PortletMode portletMode)
void	setPortletParameter(String name, String... values) Sets a URL parameter targeted to the portlet.
void	setPortletParameters(Map<String,List<String>> parameters) Sets a portlet parameter map for this URL.
void	setWindowState(WindowState windowState)

Methods inherited from interface org.jasig.portal.url.IBasePortalUrl

getPortalParameters, setPortalParameter, setPortalParameters, toString

Method Detail

setPortletParameter

void setPortletParameter(String name,
                         String... values)

Sets a URL parameter targeted to the portlet. This method replaces all parameters with the given key.

Parameters:

name - The parameter name

values - The value or values for the parameter

setPortletParameters

void setPortletParameters(Map<String,List<String>> parameters)

Sets a portlet parameter map for this URL. All previously set portal parameters are cleared.

Parameters:

parameters - Map containing parameters

getPortletParameters

Map<String,List<String>> getPortletParameters()

Get the current portlet parameters. The Map is mutable and making changes to the Map will affect the portlet parameters on the URL.

Returns:

Map containing currently set portal parameters.

setWindowState

void setWindowState(WindowState windowState)

Parameters:

windowState - The WindowState to render the portlet in

getWindowState

WindowState getWindowState()

Returns:

The currently set WindowState for the URL, will return null if setWindowState(WindowState) has not be called

setPortletMode

void setPortletMode(PortletMode portletMode)

Parameters:

portletMode - The PortletMode to render the portlet in

getPortletMode

PortletMode getPortletMode()

Returns:

The currently set PortletMode for the URL, will return null if setPortletMode(PortletMode) has not be called

setAction

void setAction(boolean action)

Parameters:

action - Set true if the request should be an action.

isAction

boolean isAction()

Returns:

true if the URL is an action URL