org.apache.jetspeed.portalsite
Interface PortalSiteRequestContext

public interface PortalSiteRequestContext

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

Version:

$Id: PortalSiteRequestContext.java 929033 2010-03-30 08:14:54Z rwatler $

Author:

Randy Watler

Method Summary

java.lang.String	getBaseFolderPath() getBaseFolderPath - return primary concrete root base folder path
java.util.Set	getCustomMenuNames() getCustomMenuNames - get set of custom menu names available as defined for the request profiled page and folder
Folder	getFolder() getFolder - get folder view relative to request profiled page
java.util.Map	getFragmentDefinitions() getFragmentDefinitions - get fragment definition view map for request profiled page and page template
java.util.Map	getLocators() getLocators - get profile locators by locator names
java.util.Map	getManagedFragmentDefinitions() getManagedFragmentDefinitions - get map of request profiled concrete fragment definition instances as managed by the page manager
BaseFragmentsElement	getManagedPageOrTemplate() getManagedPageOrTemplate - get request profiled concrete page or template instance as managed by the page manager
PageTemplate	getManagedPageTemplate() getManagedPageTemplate - get request profiled concrete page template instance as managed by the page manager
Menu	getMenu(java.lang.String name) getMenu - get instantiated menu available for the request profiled page and folder
java.lang.String	getPageContentPath() getPageContentPath - get content path associated with request page
BaseFragmentsElement	getPageOrTemplate() getPageOrTemplate - get request profiled page or template view
PageTemplate	getPageTemplate() getPageTemplate - get page template view for request profiled page
Folder	getParentFolder() getParentFolder - get parent folder view relative to request profiled page
Folder	getRootFolder() getRootFolder - get root profiled folder view
NodeSet	getRootLinks() getRootLinks - get node set of link views relative to profiled root folder
PortalSiteSessionContext	getSessionContext() getSessionContext - get component session context
NodeSet	getSiblingFolders() getSiblingFolders - get node set of sibling folder views relative to request profiled page, (includes profiled page folder view)
NodeSet	getSiblingPages() getSiblingPages - get node set of sibling page views relative to request profiled page, (includes profiled page view)
java.util.Set	getStandardMenuNames() getStandardMenuNames - get set of available standard menu names
java.lang.String	getUserFolderPath() getUserFolderPath - return primary concrete root user folder path
boolean	isConcretePage() isConcretePage - returns flag indicating request page is honoring a concrete page or content page request
boolean	isContentPage() isContentPage - returns flag indicating request page is honoring a content request

Method Detail

getSessionContext

PortalSiteSessionContext getSessionContext()

getSessionContext - get component session context

Returns:

component session context

getLocators

java.util.Map getLocators()

getLocators - get profile locators by locator names

Returns:

request profile locators

getManagedPageOrTemplate

BaseFragmentsElement getManagedPageOrTemplate()
                                              throws NodeNotFoundException

getManagedPageOrTemplate - get request profiled concrete page or template instance as managed by the page manager

Returns:

page or template

Throws:

NodeNotFoundException - if page not found

java.lang.SecurityException - if page view access not granted

getManagedPageTemplate

PageTemplate getManagedPageTemplate()
                                    throws NodeNotFoundException

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

Returns:

page template

Throws:

NodeNotFoundException - if page not found

java.lang.SecurityException - if page view access not granted

getManagedFragmentDefinitions

java.util.Map getManagedFragmentDefinitions()
                                            throws NodeNotFoundException

getManagedFragmentDefinitions - get map of request profiled concrete fragment definition instances as managed by the page manager

Returns:

map of fragment definitions by id

Throws:

NodeNotFoundException - if page or fragment definition not found

java.lang.SecurityException - if page view access not granted

isContentPage

boolean isContentPage()
                      throws NodeNotFoundException

isContentPage - returns flag indicating request page is honoring a content request

Returns:

content page flag

Throws:

NodeNotFoundException - if page not found

java.lang.SecurityException - if page view access not granted

isConcretePage

boolean isConcretePage()
                       throws NodeNotFoundException

isConcretePage - returns flag indicating request page is honoring a concrete page or content page request

Returns:

concrete page flag

Throws:

NodeNotFoundException - if page not found

java.lang.SecurityException - if page view access not granted

getPageOrTemplate

BaseFragmentsElement getPageOrTemplate()
                                       throws NodeNotFoundException

getPageOrTemplate - get request profiled page or template view

Returns:

page view

Throws:

NodeNotFoundException - if page not found

java.lang.SecurityException - if page view access not granted

getPageContentPath

java.lang.String getPageContentPath()
                                    throws NodeNotFoundException

getPageContentPath - get content path associated with request page

Returns:

content path

Throws:

NodeNotFoundException - if page not found

java.lang.SecurityException - if page view access not granted

getPageTemplate

PageTemplate getPageTemplate()
                             throws NodeNotFoundException

getPageTemplate - get page template view for request profiled page

Returns:

page template view if found or null

Throws:

NodeNotFoundException - if page not found

java.lang.SecurityException - if page view access not granted

getFragmentDefinitions

java.util.Map getFragmentDefinitions()
                                     throws NodeNotFoundException

getFragmentDefinitions - get fragment definition view map for request profiled page and page template

Returns:

map of fragment definition views by fragment id

Throws:

NodeNotFoundException - if page not found

java.lang.SecurityException - if page view access not granted

getFolder

Folder getFolder()
                 throws NodeNotFoundException

getFolder - get folder view relative to request profiled page

Returns:

page folder view

Throws:

NodeNotFoundException - if page not found

java.lang.SecurityException - if page view access not granted

getSiblingPages

NodeSet getSiblingPages()
                        throws NodeNotFoundException

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

Returns:

sibling page views

Throws:

NodeNotFoundException - if page not found

java.lang.SecurityException - if page view access not granted

getParentFolder

Folder getParentFolder()
                       throws NodeNotFoundException

getParentFolder - get parent folder view relative to request profiled page

Returns:

parent folder view or null

Throws:

NodeNotFoundException - if page not found

java.lang.SecurityException - if page view access not granted

getSiblingFolders

NodeSet getSiblingFolders()
                          throws NodeNotFoundException

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

Returns:

sibling folder views

Throws:

NodeNotFoundException - if page not found

java.lang.SecurityException - if page view access not granted

getRootFolder

Folder getRootFolder()
                     throws NodeNotFoundException

getRootFolder - get root profiled folder view

Returns:

parent folder view

Throws:

NodeNotFoundException - if page not found

java.lang.SecurityException - if page view access not granted

getRootLinks

NodeSet getRootLinks()
                     throws NodeNotFoundException

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

Returns:

root link views

Throws:

NodeNotFoundException - if page not found

java.lang.SecurityException - if page view access not granted

getStandardMenuNames

java.util.Set getStandardMenuNames()

getStandardMenuNames - get set of available standard menu names

Returns:

menu names set

getCustomMenuNames

java.util.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

java.lang.SecurityException - if page view access not granted

getMenu

Menu getMenu(java.lang.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

java.lang.SecurityException - if page view access not granted

getUserFolderPath

java.lang.String getUserFolderPath()

getUserFolderPath - return primary concrete root user folder path

Returns:

user folder path or null

getBaseFolderPath

java.lang.String getBaseFolderPath()

getBaseFolderPath - return primary concrete root base folder path

Returns:

base folder path or null