NavigationalStateComponent (Jetspeed-2 Core API 2.1.3 API)

This project has retired. For details please refer to its Attic page.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.jetspeed.container.state
Interface NavigationalStateComponent

public interface NavigationalStateComponent

NavigationalState

Version:: $Id: NavigationalStateComponent.java 516448 2007-03-09 16:25:47Z ate $
Author:: David Sean Taylor

Method Summary

NavigationalState create()
          Creates a navigational state.

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

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 Summary
`NavigationalState`	`create()` Creates a navigational state.
`PortalURL`	`createDesktopURL(javax.servlet.http.HttpServletRequest request, String characterEncoding)` Creates a Desktop Portal URL representing the URL of the request.
`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

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

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

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

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

createDesktopURL

PortalURL createDesktopURL(javax.servlet.http.HttpServletRequest request,
                           String characterEncoding)

Creates a Desktop 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.