net.sf.jportlet.portlet
Interface PortletURI

All Known Implementing Classes:

PortletURIImpl

public interface PortletURI

A PortletURI represents a URI to a specific portlet function. A URI is created through the PortletResponse. Then additional parameter can be added to the URI, action or mode can be set. The complete URI can be converted to a string which is ready for embedding into markup.

Author:

Herve Tchepannou

Method Summary

void	addParameter(java.lang.String name, java.lang.String value) Adds the given parameter to this URI.
java.lang.String	getAction() Return the name action
Portlet.Mode	getMode() Return the current mode
PortletWindow.State	getState() Returnt the state of the portlet
void	setAction(java.lang.String action) Set the name of the action
void	setMode(Portlet.Mode mode) Set the mode of the portlet
void	setState(PortletWindow.State state) Set the state of the window
java.lang.String	toString() Returns the complete URI as a string.

Method Detail

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)

Adds the given parameter to this URI. A portlet container may wish to prefix the attribute names internally, to preserve a unique namespace for the portlet

Parameters:

name -

value -

getAction

public java.lang.String getAction()

Return the name action

Returns:

String

getMode

public Portlet.Mode getMode()

Return the current mode

Returns:

Mode

getState

public PortletWindow.State getState()

Returnt the state of the portlet

Returns:

State

setAction

public void setAction(java.lang.String action)

Set the name of the action

Parameters:

action -

setMode

public void setMode(Portlet.Mode mode)

Set the mode of the portlet

Parameters:

mode -

setState

public void setState(PortletWindow.State state)

Set the state of the window

Parameters:

state -

toString

public java.lang.String toString()

Returns the complete URI as a string.

Overrides:

toString in class java.lang.Object

Returns:

String