org.jasig.portal.url
Interface IBasePortalUrl

All Known Subinterfaces:

IPortalLayoutUrl, IPortalPortletUrl, IPortletPortalUrl

public interface IBasePortalUrl

Common base for a portal URL, provides methods to set parameters for the portal. Portal URLs generally provide support for navigational changes within the portal rendered layout. The portal URL implementation 'x-www-form-urlencoded' encodes all parameter names and values. Developers should not encode them. The portal may prefix the attribute names internally

Version:

$Revision: 19776 $

Author:

Eric Dalquist

Method Summary

Map<String,List<String>>	getPortalParameters() Get the current portal parameters.
void	setPortalParameter(String name, String... values) Sets a URL parameter targeted to the portal.
void	setPortalParameters(Map<String,List<String>> parameters) Sets a portal parameter map for this URL.
String	toString()

Method Detail

setPortalParameter

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

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

Parameters:

name - The parameter name

values - The value or values for the parameter

setPortalParameters

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

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

Parameters:

parameters - Map containing parameters

getPortalParameters

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

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

Returns:

Map containing currently set portal parameters.

toString

String toString()

Overrides:

toString in class Object

Returns:

Generate a URL to be used in markup or as a redirect. The URL will be absolute, starting with a / or with a protocol such as http://