org.apache.jetspeed.portalsite
Interface PortalSiteRequestContext

public interface PortalSiteRequestContext

This describes the request context for the portal-site component.

Version:

$Id: PortalSiteRequestContext.java 516448 2007-03-09 16:25:47Z ate $

Author:

Randy Watler

Method Summary

Set	getCustomMenuNames() getCustomMenuNames - get set of custom menu names available as defined for the request profiled page and folder
Folder	getFolder() getFolder - get folder proxy relative to request profiled page
Map	getLocators() getLocators - get profile locators by locator names
Page	getManagedPage() getManagedPage - get request profiled concrete page instance as managed by the page manager
Menu	getMenu(String name) getMenu - get instantiated menu available for the request profiled page and folder
Page	getPage() getPage - get request profiled page proxy
Folder	getParentFolder() getParentFolder - get parent folder proxy relative to request profiled page
Folder	getRootFolder() getRootFolder - get root profiled folder proxy
NodeSet	getRootLinks() getRootLinks - get node set of link proxies relative to profiled root folder
PortalSiteSessionContext	getSessionContext() getSessionContext - get component session context
NodeSet	getSiblingFolders() getSiblingFolders - get node set of sibling folder proxies relative to request profiled page, (includes profiled page folder proxy)
NodeSet	getSiblingPages() getSiblingPages - get node set of sibling page proxies relative to request profiled page, (includes profiled page proxy)
Set	getStandardMenuNames() getStandardMenuNames - get set of available standard menu names

Method Detail

getSessionContext

PortalSiteSessionContext getSessionContext()

getSessionContext - get component session context

Returns:

component session context

getLocators

Map getLocators()

getLocators - get profile locators by locator names

Returns:

request profile locators

getManagedPage

Page getManagedPage()
                    throws NodeNotFoundException

getManagedPage - get request profiled concrete page instance as managed by the page manager

Returns:

page

Throws:

NodeNotFoundException - if page not found

SecurityException - if page view access not granted

getPage

Page getPage()
             throws NodeNotFoundException

getPage - get request profiled page proxy

Returns:

page proxy

Throws:

NodeNotFoundException - if page not found

SecurityException - if page view access not granted

getFolder

Folder getFolder()
                 throws NodeNotFoundException

getFolder - get folder proxy relative to request profiled page

Returns:

page folder proxy

Throws:

NodeNotFoundException - if page not found

SecurityException - if page view access not granted

getSiblingPages

NodeSet getSiblingPages()
                        throws NodeNotFoundException

getSiblingPages - get node set of sibling page proxies relative to request profiled page, (includes profiled page proxy)

Returns:

sibling page proxies

Throws:

NodeNotFoundException - if page not found

SecurityException - if page view access not granted

getParentFolder

Folder getParentFolder()
                       throws NodeNotFoundException

getParentFolder - get parent folder proxy relative to request profiled page

Returns:

parent folder proxy or null

Throws:

NodeNotFoundException - if page not found

SecurityException - if page view access not granted

getSiblingFolders

NodeSet getSiblingFolders()
                          throws NodeNotFoundException

getSiblingFolders - get node set of sibling folder proxies relative to request profiled page, (includes profiled page folder proxy)

Returns:

sibling folder proxies

Throws:

NodeNotFoundException - if page not found

SecurityException - if page view access not granted

getRootFolder

Folder getRootFolder()
                     throws NodeNotFoundException

getRootFolder - get root profiled folder proxy

Returns:

parent folder proxy

Throws:

NodeNotFoundException - if page not found

SecurityException - if page view access not granted

getRootLinks

NodeSet getRootLinks()
                     throws NodeNotFoundException

getRootLinks - get node set of link proxies relative to profiled root folder

Returns:

root link proxies

Throws:

NodeNotFoundException - if page not found

SecurityException - if page view access not granted

getStandardMenuNames

Set getStandardMenuNames()

getStandardMenuNames - get set of available standard menu names

Returns:

menu names set

getCustomMenuNames

Set getCustomMenuNames()
                       throws NodeNotFoundException

getCustomMenuNames - get set of custom menu names available as defined for the request profiled page and folder

Returns:

menu names set

Throws:

NodeNotFoundException - if page not found

SecurityException - if page view access not granted

getMenu

Menu getMenu(String name)
             throws NodeNotFoundException

getMenu - get instantiated menu available for the request profiled page and folder

Parameters:

name - menu definition name

Returns:

menu instance

Throws:

NodeNotFoundException - if page not found

SecurityException - if page view access not granted