org.apache.jetspeed.container.state
Interface NavigationalStateComponent


public interface NavigationalStateComponent

NavigationalState

Version:
$Id: NavigationalStateComponent.java 187758 2004-10-17 14:02:38Z ate $
Author:
David Sean Taylor

Method Summary
 NavigationalState create()
          Creates a navigational state.
 PortalURL createURL(javax.servlet.http.HttpServletRequest request, String characterEncoding)
          Creates a Portal URL representing the URL of the request.
 javax.portlet.PortletMode lookupPortletMode(String name)
          Given a portlet mode name, look up its object.
 javax.portlet.WindowState lookupWindowState(String name)
          Given a window state name, look up its object.
 

Method Detail

create

public NavigationalState create()
Creates a navigational state. Depending on the implementation, a navigational state context can be retrieved from a persistence store to recover the state of a page such as portlet modes and window states of portlets on a page.

Returns:
A new navigational state. This method will never return null
Throws:
FailedToCreateNavStateException - if the nav state could not be created. Under normal circumstances, this should not happen.

createURL

public PortalURL createURL(javax.servlet.http.HttpServletRequest request,
                           String characterEncoding)
Creates a Portal URL representing the URL of the request.

Parameters:
request - The ubiqitious request.
characterEncoding - String containing the name of the chararacter encoding
Returns:
A new Portal URL. This method will never return null;
Throws:
FailedToCreatePortalUrlException - if the portelt url could not be created. Under normal circumstances, this should not happen.

lookupWindowState

public javax.portlet.WindowState lookupWindowState(String name)
Given a window state name, look up its object. Ensures that we always use the same objects for WindowStates allowing for comparison by value.

Parameters:
name - The string representation of the window state.
Returns:
The corresponding WindowState object

lookupPortletMode

public javax.portlet.PortletMode lookupPortletMode(String name)
Given a portlet mode name, look up its object. Ensures that we always use the same objects for Portlet Modes allowing for comparison by value.

Parameters:
name - The string representation of the portlet mode.
Returns:
The corresponding PortletMode object


Copyright © 1999-2005 Apache Software Foundation. All Rights Reserved.