public interface PortalSiteRequestContext
Modifier and Type | Method and Description |
---|---|
String |
getBaseFolderPath()
getBaseFolderPath - return primary concrete root base folder path
|
Set<String> |
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
|
Map<String,FragmentDefinition> |
getFragmentDefinitions()
getFragmentDefinitions - get fragment definition view map for request
profiled page and page template
|
Map<String,ProfileLocator> |
getLocators()
getLocators - get profile locators by locator names
|
Map<String,FragmentDefinition> |
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(String name)
getMenu - get instantiated menu available for the request
profiled page and folder
|
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)
|
Set<String> |
getStandardMenuNames()
getStandardMenuNames - get set of available standard menu names
|
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
|
PortalSiteSessionContext getSessionContext()
Map<String,ProfileLocator> getLocators()
BaseFragmentsElement getManagedPageOrTemplate() throws NodeNotFoundException
NodeNotFoundException
- if page not foundSecurityException
- if page view access not grantedPageTemplate getManagedPageTemplate() throws NodeNotFoundException
NodeNotFoundException
- if page not foundSecurityException
- if page view access not grantedMap<String,FragmentDefinition> getManagedFragmentDefinitions() throws NodeNotFoundException
NodeNotFoundException
- if page or fragment definition not foundSecurityException
- if page view access not grantedboolean isContentPage() throws NodeNotFoundException
NodeNotFoundException
- if page not foundSecurityException
- if page view access not grantedboolean isConcretePage() throws NodeNotFoundException
NodeNotFoundException
- if page not foundSecurityException
- if page view access not grantedBaseFragmentsElement getPageOrTemplate() throws NodeNotFoundException
NodeNotFoundException
- if page not foundSecurityException
- if page view access not grantedString getPageContentPath() throws NodeNotFoundException
NodeNotFoundException
- if page not foundSecurityException
- if page view access not grantedPageTemplate getPageTemplate() throws NodeNotFoundException
NodeNotFoundException
- if page not foundSecurityException
- if page view access not grantedMap<String,FragmentDefinition> getFragmentDefinitions() throws NodeNotFoundException
NodeNotFoundException
- if page not foundSecurityException
- if page view access not grantedFolder getFolder() throws NodeNotFoundException
NodeNotFoundException
- if page not foundSecurityException
- if page view access not grantedNodeSet getSiblingPages() throws NodeNotFoundException
NodeNotFoundException
- if page not foundSecurityException
- if page view access not grantedFolder getParentFolder() throws NodeNotFoundException
NodeNotFoundException
- if page not foundSecurityException
- if page view access not grantedNodeSet getSiblingFolders() throws NodeNotFoundException
NodeNotFoundException
- if page not foundSecurityException
- if page view access not grantedFolder getRootFolder() throws NodeNotFoundException
NodeNotFoundException
- if page not foundSecurityException
- if page view access not grantedNodeSet getRootLinks() throws NodeNotFoundException
NodeNotFoundException
- if page not foundSecurityException
- if page view access not grantedSet<String> getStandardMenuNames()
Set<String> getCustomMenuNames() throws NodeNotFoundException
NodeNotFoundException
- if page not foundSecurityException
- if page view access not grantedMenu getMenu(String name) throws NodeNotFoundException
name
- menu definition nameNodeNotFoundException
- if page not foundSecurityException
- if page view access not grantedString getUserFolderPath()
String getBaseFolderPath()
Copyright © 1999–2016 The Apache Software Foundation. All rights reserved.