public interface Page extends SecuredObject
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Modifier and Type | Method and Description |
---|---|
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) |
getAccessControlList, getOwner, getSecurityContext, setAccessControlList, setOwner, supportsAccessControlList, supportsOwner, unsecuredGetAccessControlList, unsecuredGetContainers, unsecuredGetOwner, unsecuredSetAccessControlList, unsecuredSetOwner
static final java.lang.String CLASS_VERSION
Portal getPortal()
java.lang.String getId()
java.lang.String getSourceId()
java.lang.String getName()
getName(Locale)
void setName(java.lang.String pName)
setName(String, Locale)
java.lang.String getName(java.util.Locale locale)
void setName(java.lang.String name, java.util.Locale locale)
java.lang.String getDescription()
getDescription(Locale)
void setDescription(java.lang.String pDescription)
setDescription(String, Locale)
java.lang.String getDescription(java.util.Locale locale)
void setDescription(java.lang.String description, java.util.Locale locale)
description
- locale
- java.lang.String getURLName()
void setURLName(java.lang.String pURLName)
int getAccessLevel()
void setAccessLevel(int pAccessLevel)
java.util.Date getCreationDate()
java.util.Date getLastModified()
ColorPalette getColorPalette()
void setColorPalette(ColorPalette pColorPalette)
boolean isAllowLayoutChanges()
boolean isPersonalizedPage()
boolean isFixed()
void setFixed(boolean pFixed)
boolean isWirelessEnabled()
void setWirelessEnabled(boolean pWirelessEnabled)
java.lang.String getPageURI()
Community getParentCommunity()
Community
void setParentCommunity(Community pParentCommunity)
void setLayout(Layout pLayout)
java.util.Map getRegions()
Region
,
getRegionMap()
java.util.Map getRegionMap()
Region
Region getRegion(java.lang.String pRegionName)
pRegionName
- the name of a regionRegion
atg.portal.framework.folder.PageFolder getParentFolder()
PageFolder
void setParentFolder(atg.portal.framework.folder.PageFolder pPageFolder)
java.util.Set getGearSet()
Gear
void setGears(java.util.Collection pGears)
Gear
PersonalizedPage getPersonalizedPageForPrincipal(java.security.Principal principal)
java.util.Set getPersonalizedPageSet()
boolean isUserCreated()
boolean hasAccess(BaseEnvironment pEnv)
pEnv
- an environmentboolean hasAccess(AccessRight pRight) throws SecurityException
SecurityException
PortalAccessRights
,
PortalAccessRights.PAGE_RIGHTS
boolean delete() throws PortalException, SecurityException
PortalException
- if there were any errors deleting the page.SecurityException
- if the user has insufficient privileges