atg.portal.framework
Interface BaseEnvironment

All Known Subinterfaces:

Environment, GearEnvironment

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

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getRequest

javax.servlet.http.HttpServletRequest getRequest()

Access the request which initialized the environment

Returns:

a request

getCommunity

Community getCommunity()

Returns the Community for this request. If the user does not have LIST access to this community, or if the community is otherwise inapplicable, this returns null.

Returns:

a community

See Also:

Community

getCommunityFolder

atg.portal.framework.folder.CommunityFolder getCommunityFolder(java.lang.String pCommunityFolderId)

Returns the Community Folder with the Id passed, if applicable, otherwise null.

Returns:

a community folder

See Also:

CommunityFolder

getGearDefinitionFolder

atg.portal.framework.folder.GearDefinitionFolder getGearDefinitionFolder(java.lang.String pGearDefinitionFolderId)

Returns the Gear Definition Folder with the Id passed, if applicable, otherwise null.

Returns:

a gear definition folder

See Also:

GearDefinitionFolder

getPageFolder

atg.portal.framework.folder.PageFolder getPageFolder(java.lang.String pPageFolderId)

Returns the Page Folder with the Id passed, if applicable, otherwise null.

Returns:

a page folder

See Also:

PageFolder

getPage

Page getPage()

Returns the Page for this request. If the user does not have LIST access to this page, or if the page is otherwise inapplicable, this returns null.

Returns:

a page

See Also:

Page

getPages

Page[] getPages()

Returns the set of accessible pages associated with this environment.

Returns:

an array of pages

See Also:

Page

getGear

Gear getGear()

Returns the Gear for this request. If the user does not have LIST access to this gear, or if the gear is otherwise inapplicable, this returns null.

Returns:

a gear

See Also:

Gear

getServletContext

java.lang.String getServletContext()

Returns the ServletContext of the Portal Framework.

Returns:

a servlet context

getCommunityURI

java.lang.String getCommunityURI(Community pCommunity)

Returns the URI which can be used to navigate to the supplied Community.

Parameters:

pCommunity - a community

Returns:

a URI

getCommunityURI

java.lang.String getCommunityURI(java.lang.String pCommunityId)

Returns a URI which can be used to navigate to the supplied Community.

Parameters:

pCommunity - a community id

Returns:

a URI

getPageURI

java.lang.String getPageURI(Page pPage)

Returns a URI which can be used to navigate to the supplied Page.

Parameters:

pPage - a page

Returns:

a URI

getPageURI

java.lang.String getPageURI(java.lang.String pPageId)

Returns a URI which can be used to navigate to the supplied Page.

Parameters:

pPage - a page

Returns:

a URI

getAccessDeniedURI

java.lang.String getAccessDeniedURI()

Returns a URI which can be used to navigate to "access denied" notification page.

Returns:

a URI

getLoginURI

java.lang.String getLoginURI()

Returns a URI which can be used to navigate to the login page and redirect back to the current page.

Returns:

a URI

getLoginURI

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

Returns:

a URI

getLogoutURI

java.lang.String getLogoutURI()

Returns a URI which can be used to navigate to the logout page.

Returns:

a URI

getRegistrationURI

java.lang.String getRegistrationURI()

Returns a URI which can be used to navigate to the registration page.

Returns:

a URI

getRegistrationSuccessURI

java.lang.String getRegistrationSuccessURI()

Returns a URI which can be used as the successURL for the registration page

Returns:

a URI

getUpdateProfileURI

java.lang.String getUpdateProfileURI()

Returns a URI which can be used to navigate to the update profile page.

Returns:

a URI

getInactiveCommunityURI

java.lang.String getInactiveCommunityURI()

Returns a URI which can be used to navigate to the inactive community page

Returns:

a URI

isRegisteredUser

boolean isRegisteredUser()

Returns true if the current user is a registered user.

Returns:

true if the current user is a registered user, false otherwise

isPortalAdministrator

boolean isPortalAdministrator()

Returns true if the current user is a portal administrator

Returns:

true if current user is a portal administrator, false otherwise

isLeader

boolean isLeader()

Returns true if the current user is a leader

Returns:

true if current user is a leader, false otherwise

isMember

boolean isMember()

Returns true if the current user is a member

Returns:

true if current user is a member, false otherwise

isGuest

boolean isGuest()

Returns true if the current user is a guest

Returns:

true if current user is a guest, false otherwise

getPortal

Portal getPortal()

Access the Portal associated with the current request

Returns:

the Portal

See Also:

Portal