|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BaseEnvironment
A BaseEnvironment represents the context in which a portal request renders. The BaseEnvironment is used to derive information associated with any rendering reqeust.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Method Summary | |
---|---|
java.lang.String |
getAccessDeniedURI()
Returns a URI which can be used to navigate to "access denied" notification page. |
Community |
getCommunity()
Returns the Community for this request. |
atg.portal.framework.folder.CommunityFolder |
getCommunityFolder(java.lang.String pCommunityFolderId)
Returns the Community Folder with the Id passed, if applicable, otherwise null. |
java.lang.String |
getCommunityURI(Community pCommunity)
Returns the URI which can be used to navigate to the supplied Community. |
java.lang.String |
getCommunityURI(java.lang.String pCommunityId)
Returns a URI which can be used to navigate to the supplied Community. |
Gear |
getGear()
Returns the Gear for this request. |
atg.portal.framework.folder.GearDefinitionFolder |
getGearDefinitionFolder(java.lang.String pGearDefinitionFolderId)
Returns the Gear Definition Folder with the Id passed, if applicable, otherwise null. |
java.lang.String |
getInactiveCommunityURI()
Returns a URI which can be used to navigate to the inactive community page |
java.lang.String |
getLoginURI()
Returns a URI which can be used to navigate to the login page and redirect back to the current page. |
java.lang.String |
getLoginURI(boolean appendSuccessURL)
Returns a URI which can be used to navigate to the login page boolean indicates whether to append successURL |
java.lang.String |
getLogoutURI()
Returns a URI which can be used to navigate to the logout page. |
Page |
getPage()
Returns the Page for this request. |
atg.portal.framework.folder.PageFolder |
getPageFolder(java.lang.String pPageFolderId)
Returns the Page Folder with the Id passed, if applicable, otherwise null. |
Page[] |
getPages()
Returns the set of accessible pages associated with this environment. |
java.lang.String |
getPageURI(Page pPage)
Returns a URI which can be used to navigate to the supplied Page. |
java.lang.String |
getPageURI(java.lang.String pPageId)
Returns a URI which can be used to navigate to the supplied Page. |
Portal |
getPortal()
Access the Portal associated with the current request |
java.lang.String |
getRegistrationSuccessURI()
Returns a URI which can be used as the successURL for the registration page |
java.lang.String |
getRegistrationURI()
Returns a URI which can be used to navigate to the registration page. |
javax.servlet.http.HttpServletRequest |
getRequest()
Access the request which initialized the environment |
java.lang.String |
getServletContext()
Returns the ServletContext of the Portal Framework. |
java.lang.String |
getUpdateProfileURI()
Returns a URI which can be used to navigate to the update profile page. |
boolean |
isGuest()
Returns true if the current user is a guest |
boolean |
isLeader()
Returns true if the current user is a leader |
boolean |
isMember()
Returns true if the current user is a member |
boolean |
isPortalAdministrator()
Returns true if the current user is a portal administrator |
boolean |
isRegisteredUser()
Returns true if the current user is a registered user. |
Field Detail |
---|
static final java.lang.String CLASS_VERSION
Method Detail |
---|
javax.servlet.http.HttpServletRequest getRequest()
Community getCommunity()
Community
atg.portal.framework.folder.CommunityFolder getCommunityFolder(java.lang.String pCommunityFolderId)
CommunityFolder
atg.portal.framework.folder.GearDefinitionFolder getGearDefinitionFolder(java.lang.String pGearDefinitionFolderId)
GearDefinitionFolder
atg.portal.framework.folder.PageFolder getPageFolder(java.lang.String pPageFolderId)
PageFolder
Page getPage()
Page
Page[] getPages()
Page
Gear getGear()
Gear
java.lang.String getServletContext()
java.lang.String getCommunityURI(Community pCommunity)
pCommunity
- a community
java.lang.String getCommunityURI(java.lang.String pCommunityId)
pCommunity
- a community id
java.lang.String getPageURI(Page pPage)
pPage
- a page
java.lang.String getPageURI(java.lang.String pPageId)
pPage
- a page
java.lang.String getAccessDeniedURI()
java.lang.String getLoginURI()
java.lang.String getLoginURI(boolean appendSuccessURL)
java.lang.String getLogoutURI()
java.lang.String getRegistrationURI()
java.lang.String getRegistrationSuccessURI()
java.lang.String getUpdateProfileURI()
java.lang.String getInactiveCommunityURI()
boolean isRegisteredUser()
boolean isPortalAdministrator()
boolean isLeader()
boolean isMember()
boolean isGuest()
Portal getPortal()
Portal
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |