atg.portal.framework
Interface Page

All Superinterfaces:

SecuredObject

All Known Subinterfaces:

PersonalizedPage

public interface Page
extends SecuredObject

Pages are components which allow for the arrangment of multiple gears.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

boolean	delete() Deletes the page.
int	getAccessLevel() Access the access level of the page
ColorPalette	getColorPalette() Access the color palette of the page
java.util.Date	getCreationDate() Access the creation date of the page
java.lang.String	getDescription() Deprecated.
java.lang.String	getDescription(java.util.Locale locale) Gets the localized description of this gear, returning a default string if the locale is not recognized.
java.util.Set	getGearSet() Returns the set of gears found on this page.
java.lang.String	getId() Access the id of the page
java.util.Date	getLastModified() Access the last modified date of the page
Layout	getLayout() Access the page layout
java.lang.String	getName() Deprecated.
java.lang.String	getName(java.util.Locale locale) Gets the localized name of this gear, returning a default string if the locale is not recognized.
java.lang.String	getPageURI()
Community	getParentCommunity() Access the parent community
atg.portal.framework.folder.PageFolder	getParentFolder() Access the parent folder of this page
PersonalizedPage	getPersonalizedPageForPrincipal(java.security.Principal principal) Retrieves the personalized version of this page for the given principal, or null if none exists.
java.util.Set	getPersonalizedPageSet() Returns the set of personalized pages that have this page as the source page.
Portal	getPortal() Returns the portal that this page is associated with.
Region	getRegion(java.lang.String pRegionName) Access a named region
java.util.Map	getRegionMap() Returns a map of regions on the page, indexed by name.
java.util.Map	getRegions() Deprecated.
java.lang.String	getSourceId() Access the source id of the page
java.lang.String	getURLName() Access the URL of the page
boolean	hasAccess(AccessRight pRight) Returns true if the current user has the specified access to the page.
boolean	hasAccess(BaseEnvironment pEnv) Deprecated.
boolean	isAllowLayoutChanges() True if the page accepts layout changes
boolean	isFixed() True if the page is fixed
boolean	isPersonalizedPage() True if the page is a personalized page
boolean	isUserCreated() If the page is create by a user as opposed to an admin/leader.
boolean	isWirelessEnabled()
void	setAccessLevel(int pAccessLevel) Set the accesss level for this page
void	setColorPalette(ColorPalette pColorPalette) Sets the color palette of this page
void	setDescription(java.lang.String pDescription) Deprecated.
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the description of the page for the given locale.
void	setFixed(boolean pFixed) Set if the page should allow customization
void	setGears(java.util.Collection pGears) Set the Gears for this page
void	setLayout(Layout pLayout) Sets the layout of this page
void	setName(java.lang.String pName) Deprecated.
void	setName(java.lang.String name, java.util.Locale locale) Sets the name of the page for the given locale.
void	setParentCommunity(Community pParentCommunity) Sets the parent community for this page
void	setParentFolder(atg.portal.framework.folder.PageFolder pPageFolder) Sets the parent page folder for this page
void	setURLName(java.lang.String pURLName) Set the url name for this page
void	setWirelessEnabled(boolean pWirelessEnabled)

Methods inherited from interface atg.security.SecuredObject

getAccessControlList, getOwner, getSecurityContext, setAccessControlList, setOwner, supportsAccessControlList, supportsOwner, unsecuredGetAccessControlList, unsecuredGetContainers, unsecuredGetOwner, unsecuredSetAccessControlList, unsecuredSetOwner

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getPortal

Portal getPortal()

Returns the portal that this page is associated with.

getId

java.lang.String getId()

Access the id of the page

Returns:

an id

getSourceId

java.lang.String getSourceId()

Access the source id of the page

Returns:

an id

getName

java.lang.String getName()

Deprecated.

Access the name of the gear

Returns:

a name

See Also:

getName(Locale)

setName

void setName(java.lang.String pName)

Deprecated.

Sets the name of the gear

See Also:

setName(String, Locale)

getName

java.lang.String getName(java.util.Locale locale)

Gets the localized name of this gear, returning a default string if the locale is not recognized.

setName

void setName(java.lang.String name,
             java.util.Locale locale)

Sets the name of the page for the given locale.

getDescription

java.lang.String getDescription()

Deprecated.

Access a description of the gear

Returns:

a description

See Also:

getDescription(Locale)

setDescription

void setDescription(java.lang.String pDescription)

Deprecated.

Sets the description of this gear

See Also:

setDescription(String, Locale)

getDescription

java.lang.String getDescription(java.util.Locale locale)

Gets the localized description of this gear, returning a default string if the locale is not recognized.

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale)

Sets the description of the page for the given locale.

Parameters:

description -

locale -

getURLName

java.lang.String getURLName()

Access the URL of the page

Returns:

a description

setURLName

void setURLName(java.lang.String pURLName)

Set the url name for this page

getAccessLevel

int getAccessLevel()

Access the access level of the page

Returns:

a description

setAccessLevel

void setAccessLevel(int pAccessLevel)

Set the accesss level for this page

getCreationDate

java.util.Date getCreationDate()

Access the creation date of the page

Returns:

a date

getLastModified

java.util.Date getLastModified()

Access the last modified date of the page

Returns:

a date

getColorPalette

ColorPalette getColorPalette()

Access the color palette of the page

Returns:

a color palette

setColorPalette

void setColorPalette(ColorPalette pColorPalette)

Sets the color palette of this page

isAllowLayoutChanges

boolean isAllowLayoutChanges()

True if the page accepts layout changes

Returns:

true if this page accepts layout changes, false otherwise

isPersonalizedPage

boolean isPersonalizedPage()

True if the page is a personalized page

Returns:

true if the page is personalized, false otherwise

isFixed

boolean isFixed()

True if the page is fixed

Returns:

true if the page is fixed, false otherwise

setFixed

void setFixed(boolean pFixed)

Set if the page should allow customization

isWirelessEnabled

boolean isWirelessEnabled()

Returns:

whether or not this page is enabled for wireless devices

setWirelessEnabled

void setWirelessEnabled(boolean pWirelessEnabled)

getPageURI

java.lang.String getPageURI()

Returns:

the uri which can be user to navigate to the supplied page

getParentCommunity

Community getParentCommunity()

Access the parent community

Returns:

the parent community

See Also:

Community

setParentCommunity

void setParentCommunity(Community pParentCommunity)

Sets the parent community for this page

getLayout

Layout getLayout()

Access the page layout

Returns:

a page layout

See Also:

Layout

setLayout

void setLayout(Layout pLayout)

Sets the layout of this page

getRegions

java.util.Map getRegions()

Deprecated.

Returns a map of regions on the page, indexed by name. This method has been deprecated; getRegionMap() should be used instead.

Returns:

a map regions

See Also:

Region, getRegionMap()

getRegionMap

java.util.Map getRegionMap()

Returns a map of regions on the page, indexed by name.

Returns:

a map regions

See Also:

Region

getRegion

Region getRegion(java.lang.String pRegionName)

Access a named region

Parameters:

pRegionName - the name of a region

Returns:

a region

See Also:

Region

getParentFolder

atg.portal.framework.folder.PageFolder getParentFolder()

Access the parent folder of this page

Returns:

a PageFolder

See Also:

PageFolder

setParentFolder

void setParentFolder(atg.portal.framework.folder.PageFolder pPageFolder)

Sets the parent page folder for this page

getGearSet

java.util.Set getGearSet()

Returns the set of gears found on this page.

Returns:

a Set of Gears

See Also:

Gear

setGears

void setGears(java.util.Collection pGears)

Set the Gears for this page

See Also:

Gear

getPersonalizedPageForPrincipal

PersonalizedPage getPersonalizedPageForPrincipal(java.security.Principal principal)

Retrieves the personalized version of this page for the given principal, or null if none exists.

getPersonalizedPageSet

java.util.Set getPersonalizedPageSet()

Returns the set of personalized pages that have this page as the source page. Care should be used in utilizing this method as the set of personalized pages may be very large.

isUserCreated

boolean isUserCreated()

If the page is create by a user as opposed to an admin/leader. Personalized pages which are a variation of an admin created page are not considered user created.

Returns:

hasAccess

boolean hasAccess(BaseEnvironment pEnv)

Deprecated.

Returns true if the current environment has access to the page. This method has been deprecated in favor of the hasAccess(AccessRight) method. This method is equivalent to calling hasAccess(atg.portal.framework.PortalAccessRights.READ).

Parameters:

pEnv - an environment

Returns:

true if the current environment has access to the page, false otherwise

hasAccess

boolean hasAccess(AccessRight pRight)
                  throws SecurityException

Returns true if the current user has the specified access to the page.

Throws:

SecurityException

See Also:

PortalAccessRights, PortalAccessRights.PAGE_RIGHTS

delete

boolean delete()
               throws PortalException,
                      SecurityException

Deletes the page.

Throws:

PortalException - if there were any errors deleting the page.

SecurityException - if the user has insufficient privileges