| org.apache.jetspeed.container.state.NavigationalStateComponent
All known Subclasses: org.apache.jetspeed.container.state.impl.JetspeedNavigationalStateComponent,
| NavigationalStateComponent | | public interface NavigationalStateComponent (Code) | | NavigationalState
author:
David Sean Taylor
version:
$Id: NavigationalStateComponent.java 516448 2007-03-09 16:25:47Z ate $ |
| Method Summary | |
| 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.
A new navigational state. | | PortalURL | createDesktopURL(HttpServletRequest request, String characterEncoding)
Creates a Desktop Portal URL representing the URL of the request.
Parameters:
request - The ubiqitious request.
Parameters:
characterEncoding - String containing the name of the chararacter encoding A new Portal URL. | | PortalURL | createURL(HttpServletRequest request, String characterEncoding)
Creates a Portal URL representing the URL of the request.
Parameters:
request - The ubiqitious request.
Parameters:
characterEncoding - String containing the name of the chararacter encoding A new Portal URL. | | 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. | | 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. |
| create | | NavigationalState create()(Code) | | 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.
A new navigational state. This method will never return null
throws:
FailedToCreateNavStateException - if the nav state could not be created. Under normalcircumstances, this should not happen. |
| createDesktopURL | | PortalURL createDesktopURL(HttpServletRequest request, String characterEncoding)(Code) | | Creates a Desktop Portal URL representing the URL of the request.
Parameters:
request - The ubiqitious request.
Parameters:
characterEncoding - String containing the name of the chararacter encoding A new Portal URL. This method will never return null;
throws:
FailedToCreatePortalUrlException - if the portelt url could not be created. Under normalcircumstances, this should not happen. |
| createURL | | PortalURL createURL(HttpServletRequest request, String characterEncoding)(Code) | | Creates a Portal URL representing the URL of the request.
Parameters:
request - The ubiqitious request.
Parameters:
characterEncoding - String containing the name of the chararacter encoding A new Portal URL. This method will never return null;
throws:
FailedToCreatePortalUrlException - if the portelt url could not be created. Under normalcircumstances, this should not happen. |
| lookupPortletMode | | PortletMode lookupPortletMode(String name)(Code) | | 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. The corresponding PortletMode object |
| lookupWindowState | | WindowState lookupWindowState(String name)(Code) | | 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. The corresponding WindowState object |
|
|