org.apache.pluto.services.information
Interface PortletURLProvider

public interface PortletURLProvider

Method Summary

void	clearParameters() Removes all pre-existing parameters in this URL
void	setAction() By calling this method the URL is defined as an action URL.
void	setParameters(java.util.Map parameters) Sets the given parameters as parameters into the URL, Removes all previously set parameters.
void	setPortletMode(javax.portlet.PortletMode mode) Sets the new portlet mode at the URL.
void	setSecure() By calling this method the URL is defined as a secure URL.
void	setWindowState(javax.portlet.WindowState state) Sets the new window state at the URL.
java.lang.String	toString() Returns the URL in string format.

Method Detail

setPortletMode

public void setPortletMode(javax.portlet.PortletMode mode)

Sets the new portlet mode at the URL. If no mode is set at the URL the currently active mode is used.

Parameters:

mode - the new portlet mode

setWindowState

public void setWindowState(javax.portlet.WindowState state)

Sets the new window state at the URL. If no state is set at the URL the currently active state is used.

Parameters:

state - the new window state

setAction

public void setAction()

By calling this method the URL is defined as an action URL. If this URL is execute the action() method will be called at the portlet entity linked with the URL.

setSecure

public void setSecure()

By calling this method the URL is defined as a secure URL.

clearParameters

public void clearParameters()

Removes all pre-existing parameters in this URL

setParameters

public void setParameters(java.util.Map parameters)

Sets the given parameters as parameters into the URL, Removes all previously set parameters.

Parameters:

parameters - a map containing the name [java.lang.String] and value [java.lang.String[]] of the parameters.

toString

public java.lang.String toString()

Returns the URL in string format. This method should only be called once.

Returns:

the URL