IBM WebSphere Application ServerTM
Release 8

com.ibm.portal.state
Interface RedirectURLGenerator

All Superinterfaces:
java.io.Serializable

public interface RedirectURLGenerator
extends java.io.Serializable

The Redirect URL Generator provides methods to create URLs pointing to pages or portlets.
The Redirect URLGenerator must be obtained once per action phase of a portlet and should not be stored.

See Also:
URLGeneratorFactoryService

Method Summary
 EngineURL createPageURL(ObjectID pageID)
          Creates an url that points to the page referenced by the pageID.
 EngineURL createPortletURL(ObjectID portletWindowID)
          Currently not supported, will always throw a StateException.
 

Method Detail

createPageURL

EngineURL createPageURL(ObjectID pageID)
                        throws StateException
Creates an url that points to the page referenced by the pageID.

Parameters:
pageID - The object id of the page. It is not allowed to pass null for this parameter.
Returns:
EngineURL The url.
Throws:
StateException - Thrown when an error occurs during the creation of the URL.

createPortletURL

EngineURL createPortletURL(ObjectID portletWindowID)
                           throws StateException
Currently not supported, will always throw a StateException.

Parameters:
portletWindowID - The object id of the portlet window. It is not allowed to pass null for this parameter.
Returns:
EngineURL The url.
Throws:
StateException - Thrown when an error occurs during the creation of the URL.

IBM WebSphere Application ServerTM
Release 8