atg.portal.framework

Interface Portal

All Superinterfaces:

SecuredObject

public interface Portal
extends SecuredObject

Base-level object that describes a portal.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Method Summary

Modifier and Type	Method and Description
ColorPalette	createColorPalette(atg.portal.xml.configuration.PortalObjectConfiguration pConfig) Creates a new color with the configuration item passed.
Community	createCommunity(java.lang.String pCommunityName, java.lang.String pURL, atg.portal.framework.folder.CommunityFolder pCommunityFolder) Create a new Community with the given paramaters.
Community	createCommunity(java.lang.String pCommmunityName, java.lang.String pURL, atg.portal.framework.folder.CommunityFolder pParentFolder, java.lang.String pDescription, java.lang.String pMembershipRequest, PageTemplate pPageTemplate, Style pStyle, atg.portal.framework.GearTitleTemplate pGearTitleTemplate, boolean pActive, java.lang.String pPersonalizationLevel, int pAccessLevel) Create a new Community with the parameters passed in.
Community	createCommunity(java.lang.String pCommmunityName, java.lang.String pURL, atg.portal.framework.folder.CommunityFolder pParentFolder, java.lang.String pDescription, java.lang.String pMembershipRequest, PageTemplate pPageTemplate, Style pStyle, atg.portal.framework.GearTitleTemplate pGearTitleTemplate, boolean pActive, java.lang.String pPersonalizationLevel, int pAccessLevel, Layout pLayout, ColorPalette pColorPalette) Create a community with the given parameters
atg.portal.framework.folder.Folder	createFolder(java.lang.String pType, java.lang.String pFolderName, java.lang.String pFolderUrl, java.lang.String pParentFolder) Creates a new folder with the parameters passed.
GearDefinition	createGearDefinition(atg.portal.xml.configuration.PortalObjectConfiguration pConfig) Creates a new gear definition with the configuration item passed.
atg.portal.framework.GearTitleTemplate	createGearTemplate(atg.portal.xml.configuration.PortalObjectConfiguration pConfig) Creates a new gear title template with the configuration item passed.
Layout	createLayoutTemplate(atg.portal.xml.configuration.PortalObjectConfiguration pConfig) Creates a new layout template with the configuration item passed.
PageTemplate	createPageTemplate(atg.portal.xml.configuration.PortalObjectConfiguration pConfig) Creates a new page template with the configuration item passed.
atg.portal.framework.PersonalizedCommunity	createPersonalizedCommunityForPrincipal(Community pSourceCommunity, java.security.Principal pPrincipal) creates a PersonalizedCommunity
PersonalizedPage	createPersonalizedPageForPrincipal(Page pSourcePage, java.security.Principal pPrincipal) creates a PersonalizedPage for the given Principal using pSourcePage as its source.
Style	createStyle(atg.portal.xml.configuration.PortalObjectConfiguration pConfig) Creates a new style with the configuration item passed.
boolean	deleteCommunity(Community pCommunity) Delete the given community
void	deleteGearDefinition(java.lang.String pGearDefinitionId) Delete a gear definition with the id passed.
void	deleteGearTemplate(java.lang.String pGearTemplateName) Delete a gear title template with the name passed.
void	deleteLayoutTemplate(java.lang.String pLayoutTemplateName) Delete a layout template with the name passed.
void	deletePageTemplate(java.lang.String pPageTemplateName) Delete a page template with the name passed.
void	deleteStyle(java.lang.String pStyleName) Delete a style with the name passed.
ColorPalette	getColorPaletteById(java.lang.String colorPaletteId) Retrieves a color palette by its unique ID.
java.util.Set	getColorPaletteSet() Retrieves a set of colors available to the user.
java.util.Set	getColorPaletteSet(java.util.Comparator pComparator) Retrieves a set of colors available to the user sorted based on the given comparator.
Community	getCommunityById(java.lang.String communityId) Retrieves a community object by its unique ID.
atg.portal.framework.folder.CommunityFolder	getCommunityFolderById(java.lang.String folderId) Retrieves a community folder object by its unique ID.
java.util.Set	getCommunityFolderSet() Retrieves a set of community folder objects that the user can see.
java.util.Set	getCommunityFolderSet(java.util.Comparator pComparator) Retrieves a set of community folder objects that the user can see sorted based on the comparator given.
atg.portal.framework.RelativeRoleManager	getCommunityRoleManager() Returns the relative role manager for community relative roles.
java.util.Set	getCommunitySet() Retrieves a set of community objects that the user can see.
java.util.Set	getCommunitySet(java.util.Comparator pComparator) Retrieves a set of community objects that the user can see sorted based on the comparator given.
java.lang.String	getContextPath() Access the portal context path
DirectoryPrincipal	getDirectoryPrincipal(java.security.Principal securityPrincipal) Converts a security Principal into a user directory DirectoryPrincipal.
DisplayMode	getDisplayModeById(java.lang.String displayModeId) Retrieves a display mode by its unique ID.
atg.portal.framework.folder.Folder	getFolderById(java.lang.String folderId) Retrieves a folder object.
Gear	getGearById(Community community, java.lang.String gearId) Retrieves a gear object by its unique ID within the indicated community.
Gear	getGearById(Page page, java.lang.String gearId) Retrieves a gear object by its unique ID within the indicated page.
Gear	getGearById(java.lang.String pGearId) Retrieves a gear by its unique ID.
GearDefinition	getGearDefinitionById(java.lang.String gearDefinitionId) Retrieves a gear definition by its unique ID.
GearDefinition	getGearDefinitionByNameAndAuthor(java.lang.String gearDefinitionName, java.lang.String authorName) Retrieves a gear definition by name.
GearDefinition	getGearDefinitionByPortletGUID(java.lang.String guid) Retrieves a gear definition by its Portlet Standard GUID.
atg.portal.framework.folder.GearDefinitionFolder	getGearDefinitionFolderById(java.lang.String gearDefinitionFolderId) Retrieves a gear definition folder by its unique ID.
java.util.Set	getGearDefinitionFolderSet() Retrieves a set of gear definition folder objects that the user can see.
java.util.Set	getGearDefinitionFolderSet(java.util.Comparator pComparator) Retrieves a set of gear definitions objects that the user can see sorted based on the comparator given.
java.lang.String	getGearDefinitionId(java.lang.String pName, java.lang.String pAuthor) Retrieves an Id of a gear definition by name and author
java.lang.String	getGearDefinitionId(java.lang.String pName, java.lang.String pAuthor, java.lang.String pVersion) Retrieves an Id of a gear definition by name, author and version
java.util.Set	getGearDefinitionSet() Retrieves a set of gear definition objects that the user can see.
java.util.Set	getGearDefinitionSet(java.util.Comparator pComparator) Retrieves a set of gear definition objects that the user can see sorted based on the comparator given.
GearMode	getGearModeById(java.lang.String gearModeId) Retrieves a gear mode by its unique ID.
GearParameter	getGearParameterById(java.lang.String gearParameterId) Retrieves a gear parameter by its unique ID.
java.util.Set	getGearSet() Retrieves a set of gears that the user can make use of.
java.util.Set	getGearSet(java.util.Comparator pComparator) Retrieves a set of page folder objects that the user can see sorted based on the comparator given.
atg.portal.framework.GearTitleTemplate	getGearTitleTemplateById(java.lang.String gearTitleTemplateId) Retrives a gear title template by its unique ID.
java.util.Set	getGearTitleTemplateSet() Retrieves a set of gear title objects that the user can see.
java.util.Set	getGearTitleTemplateSet(java.util.Comparator pComparator)
java.lang.String	getId() Returns the ID of the portal.
Layout	getLayoutById(java.lang.String layoutId) Retrieves a layout by its unique ID.
java.util.Set	getLayoutSet() Retrieves a set of layouts that the user can make use of.
java.util.Set	getLayoutSet(java.util.Comparator pComparator)
java.lang.String	getName() Returns the name of the portal.
java.lang.String	getName(java.util.Locale locale) Returns the name of the portal for the given locale, if possible.
Page	getPageById(java.lang.String pageId) Retrieves a page object by its unique ID.
atg.portal.framework.folder.PageFolder	getPageFolderById(java.lang.String pageFolderId) Retrieves a pageFolder by its unique ID.
java.util.Set	getPageFolderSet() Retrieves a set of page folder objects that the user can see.
java.util.Set	getPageFolderSet(java.util.Comparator pComparator) Retrieves a set of page folder objects that the user can see sorted based on the comparator given.
java.util.Set	getPageSet() Retrieves a set of pages that the user can see.
java.util.Set	getPageSet(java.util.Comparator pComparator) Retrieves a set of pages that the user can see.
PageTemplate	getPageTemplateById(java.lang.String pageTemplateId) Retrieves a page template by its unique ID.
java.util.Set	getPageTemplateSet() Retrieves a set of page templates that the user can see.
java.util.Set	getPageTemplateSet(java.util.Comparator pComparator) Retrieves a set of page templates that the user can see sorted based on the comparator given.
atg.portal.framework.PersonalizedCommunity	getPersonalizedCommunityById(java.lang.String communityId) Deprecated. use getCommunityById
atg.portal.framework.PersonalizedCommunity	getPersonalizedCommunityForPrincipal(Community community, java.security.Principal principal) Retrieves the personalized version of a community for the given principal, or null if none exists.
PersonalizedPage	getPersonalizedPageById(java.lang.String pageId) Deprecated. use getPageById
PersonalizedPage	getPersonalizedPageForPrincipal(Page page, java.security.Principal principal) Retrieves the personalized version of a page for the given principal, or null if none exists.
Role	getPortalAdministratorRole() Returns the user directory Role for the portal administrator.
java.security.Principal	getPortalAdministratorSecurityPrincipal() Returns the security principal for the portal administrator.
Region	getRegionById(java.lang.String regionId) Retrieves a region by its unique ID.
RegionDefinition	getRegionDefinitionById(java.lang.String regionDefinitionId) Retrieves a region definition by its unique ID.
java.util.Set	getRegionSet() Retrieves the set of regions known to the system.
java.util.Set	getRegionSet(java.util.Comparator pComparator) Retrieves a set of regions that the user can see sorted based on the comparator given.
java.lang.String	getRepositoryItemId(java.lang.String pName, java.lang.String pType) Retrieves an Id of a portal object
atg.portal.framework.folder.CommunityFolder	getRootCommunityFolder() Returns the root folder of the community folder tree.
atg.portal.framework.folder.GearDefinitionFolder	getRootGearDefinitionFolder() Returns the root folder of the gear definition folder tree.
atg.portal.framework.folder.PageFolder	getRootPageFolder() Returns the root folder of the page folder tree.
java.security.Principal	getSecurityPrincipal(DirectoryPrincipal directoryPrincipal) Converts a DirectoryPrincipal (any of the identity objects returned by the UserDirectory) into a security Principal.
Style	getStyleById(java.lang.String styleId) Retrieves a style by its unique ID.
java.util.Set	getStyleSet() Retrieves the set of styles known to the system.
java.util.Set	getStyleSet(java.util.Comparator pComparator) Retrieves the set of styles known to the system sorted based on the comparator given.
UserDirectory	getUserDirectory() Returns the user directory that can be used for managing user identities, organizations, and roles.
boolean	hasAccess(AccessRight pRight) Returns true if the current user has the indicated access to this community.
boolean	isChildCommunityFolder(java.lang.String pParent, java.lang.String pChild) checks if the community folder is a child of the parent folder object
boolean	isChildGearDefinitionFolder(java.lang.String pParent, java.lang.String pChild, java.lang.String pItemDescriptor) checks if the gear definition folder is a child of the parent folder object
boolean	isLoggedIn() Returns true if the current user has logged in.
boolean	isPortalAdministrator() Returns true if the curren tuser is the portal administrator.
boolean	isReservedCommunityURL(java.lang.String pURLName) Check if the given URL is the same as one of the reserverd community URLs
void	updateColorPalette(ColorPalette pColor, atg.portal.xml.configuration.PortalObjectConfiguration pConfig) Updates a color palette with the configuration item passed.
void	updateGearDefinition(GearDefinition pGearDefinition, atg.portal.xml.configuration.PortalObjectConfiguration pConfig) Updates a gear definition with the configuration item passed.
void	updateGearTemplate(atg.portal.framework.GearTitleTemplate pGearTitleTemplate, atg.portal.xml.configuration.PortalObjectConfiguration pConfig) Updates a gear title template with the configuration item passed.
void	updateLayoutTemplate(Layout pLayout, atg.portal.xml.configuration.PortalObjectConfiguration pConfig) Updates a layout template with the configuration item passed.
void	updatePageTemplate(PageTemplate pPageTemplate, atg.portal.xml.configuration.PortalObjectConfiguration pConfig) Updates a page template with the configuration item passed.
void	updateStyle(Style pStyle, atg.portal.xml.configuration.PortalObjectConfiguration pConfig) Updates a style with the configuration item passed.

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

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Returns the ID of the portal.

getName

java.lang.String getName()

Returns the name of the portal.

getName

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

Returns the name of the portal for the given locale, if possible.

getContextPath

java.lang.String getContextPath()

Access the portal context path

getCommunityFolderById

atg.portal.framework.folder.CommunityFolder getCommunityFolderById(java.lang.String folderId)
                                                            throws SecurityException

Retrieves a community folder object by its unique ID.

Throws:

SecurityException

getFolderById

atg.portal.framework.folder.Folder getFolderById(java.lang.String folderId)
                                          throws SecurityException

Retrieves a folder object. The retuned object could be instance of #CommunityFolder, #GearDefinitionFolder or #PageFolder

Throws:

SecurityException

getCommunityById

Community getCommunityById(java.lang.String communityId)
                    throws SecurityException

Retrieves a community object by its unique ID.

Throws:

SecurityException

getPersonalizedCommunityById

atg.portal.framework.PersonalizedCommunity getPersonalizedCommunityById(java.lang.String communityId)
                                                                 throws SecurityException

Deprecated. use getCommunityById

Retrieves a personalized community object by its unique ID.

Throws:

SecurityException

getPersonalizedCommunityForPrincipal

atg.portal.framework.PersonalizedCommunity getPersonalizedCommunityForPrincipal(Community community,
                                                                                java.security.Principal principal)
                                                                         throws SecurityException

Retrieves the personalized version of a community for the given principal, or null if none exists.

Throws:

SecurityException

getPageById

Page getPageById(java.lang.String pageId)
          throws SecurityException

Retrieves a page object by its unique ID.

Throws:

SecurityException

getPersonalizedPageById

PersonalizedPage getPersonalizedPageById(java.lang.String pageId)
                                  throws SecurityException

Deprecated. use getPageById

Retrieves a personalized object by its unique ID.

Throws:

SecurityException

getPersonalizedPageForPrincipal

PersonalizedPage getPersonalizedPageForPrincipal(Page page,
                                                 java.security.Principal principal)

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

getColorPaletteById

ColorPalette getColorPaletteById(java.lang.String colorPaletteId)
                          throws SecurityException

Retrieves a color palette by its unique ID.

Throws:

SecurityException

getGearById

Gear getGearById(Community community,
                 java.lang.String gearId)
          throws SecurityException

Retrieves a gear object by its unique ID within the indicated community.

Throws:

SecurityException

getGearById

Gear getGearById(Page page,
                 java.lang.String gearId)
          throws SecurityException

Retrieves a gear object by its unique ID within the indicated page.

Throws:

SecurityException

getGearById

Gear getGearById(java.lang.String pGearId)
          throws SecurityException

Retrieves a gear by its unique ID. This is a context-free version of the gear, without known parentage information. This method should be rarely used.

Throws:

SecurityException

getGearDefinitionFolderById

atg.portal.framework.folder.GearDefinitionFolder getGearDefinitionFolderById(java.lang.String gearDefinitionFolderId)
                                                                      throws SecurityException

Retrieves a gear definition folder by its unique ID.

Throws:

SecurityException

getGearDefinitionByNameAndAuthor

GearDefinition getGearDefinitionByNameAndAuthor(java.lang.String gearDefinitionName,
                                                java.lang.String authorName)
                                         throws SecurityException

Retrieves a gear definition by name.

Throws:

SecurityException

getGearDefinitionById

GearDefinition getGearDefinitionById(java.lang.String gearDefinitionId)
                              throws SecurityException

Retrieves a gear definition by its unique ID.

Throws:

SecurityException

getGearDefinitionByPortletGUID

GearDefinition getGearDefinitionByPortletGUID(java.lang.String guid)
                                       throws SecurityException

Retrieves a gear definition by its Portlet Standard GUID. Only applies if the gear is a JSR168 portlet.

Parameters:

guid -

Returns:

Throws:

SecurityException

getGearParameterById

GearParameter getGearParameterById(java.lang.String gearParameterId)
                            throws SecurityException

Retrieves a gear parameter by its unique ID.

Throws:

SecurityException

getGearModeById

GearMode getGearModeById(java.lang.String gearModeId)
                  throws SecurityException

Retrieves a gear mode by its unique ID.

Throws:

SecurityException

getGearTitleTemplateById

atg.portal.framework.GearTitleTemplate getGearTitleTemplateById(java.lang.String gearTitleTemplateId)
                                                         throws SecurityException

Retrives a gear title template by its unique ID.

Throws:

SecurityException

getLayoutById

Layout getLayoutById(java.lang.String layoutId)
              throws SecurityException

Retrieves a layout by its unique ID.

Throws:

SecurityException

getPageTemplateById

PageTemplate getPageTemplateById(java.lang.String pageTemplateId)

Retrieves a page template by its unique ID.

getRegionById

Region getRegionById(java.lang.String regionId)
              throws SecurityException

Retrieves a region by its unique ID.

Throws:

SecurityException

getRegionDefinitionById

RegionDefinition getRegionDefinitionById(java.lang.String regionDefinitionId)
                                  throws SecurityException

Retrieves a region definition by its unique ID.

Throws:

SecurityException

getStyleById

Style getStyleById(java.lang.String styleId)
            throws SecurityException

Retrieves a style by its unique ID.

Throws:

SecurityException

getDisplayModeById

DisplayMode getDisplayModeById(java.lang.String displayModeId)
                        throws SecurityException

Retrieves a display mode by its unique ID.

Throws:

SecurityException

getPageFolderById

atg.portal.framework.folder.PageFolder getPageFolderById(java.lang.String pageFolderId)
                                                  throws SecurityException

Retrieves a pageFolder by its unique ID.

Throws:

SecurityException

getColorPaletteSet

java.util.Set getColorPaletteSet()

Retrieves a set of colors available to the user.

getColorPaletteSet

java.util.Set getColorPaletteSet(java.util.Comparator pComparator)

Retrieves a set of colors available to the user sorted based on the given comparator. If pComparator is null the set is returned unsorted.

getCommunitySet

java.util.Set getCommunitySet()

Retrieves a set of community objects that the user can see. This method should be used with care, as it may return a large result set.

getCommunitySet

java.util.Set getCommunitySet(java.util.Comparator pComparator)

Retrieves a set of community objects that the user can see sorted based on the comparator given.

getGearDefinitionFolderSet

java.util.Set getGearDefinitionFolderSet()

Retrieves a set of gear definition folder objects that the user can see.

getGearDefinitionFolderSet

java.util.Set getGearDefinitionFolderSet(java.util.Comparator pComparator)

Retrieves a set of gear definitions objects that the user can see sorted based on the comparator given.

getCommunityFolderSet

java.util.Set getCommunityFolderSet()

Retrieves a set of community folder objects that the user can see.

getCommunityFolderSet

java.util.Set getCommunityFolderSet(java.util.Comparator pComparator)

Retrieves a set of community folder objects that the user can see sorted based on the comparator given.

getPageFolderSet

java.util.Set getPageFolderSet()

Retrieves a set of page folder objects that the user can see.

getPageFolderSet

java.util.Set getPageFolderSet(java.util.Comparator pComparator)

Retrieves a set of page folder objects that the user can see sorted based on the comparator given.

getGearDefinitionSet

java.util.Set getGearDefinitionSet()

Retrieves a set of gear definition objects that the user can see.

getGearDefinitionSet

java.util.Set getGearDefinitionSet(java.util.Comparator pComparator)

Retrieves a set of gear definition objects that the user can see sorted based on the comparator given.

getGearTitleTemplateSet

java.util.Set getGearTitleTemplateSet()

Retrieves a set of gear title objects that the user can see.

getGearTitleTemplateSet

java.util.Set getGearTitleTemplateSet(java.util.Comparator pComparator)

getGearSet

java.util.Set getGearSet()

Retrieves a set of gears that the user can make use of.

getGearSet

java.util.Set getGearSet(java.util.Comparator pComparator)

Retrieves a set of page folder objects that the user can see sorted based on the comparator given.

getLayoutSet

java.util.Set getLayoutSet()

Retrieves a set of layouts that the user can make use of.

getLayoutSet

java.util.Set getLayoutSet(java.util.Comparator pComparator)

getPageSet

java.util.Set getPageSet()

Retrieves a set of pages that the user can see. This method should be used with care, as it may return a large result set.

getPageSet

java.util.Set getPageSet(java.util.Comparator pComparator)

Retrieves a set of pages that the user can see. This method should be used with care, as it may return a large result set.

getPageTemplateSet

java.util.Set getPageTemplateSet()

Retrieves a set of page templates that the user can see.

getPageTemplateSet

java.util.Set getPageTemplateSet(java.util.Comparator pComparator)

Retrieves a set of page templates that the user can see sorted based on the comparator given.

getRegionSet

java.util.Set getRegionSet()

Retrieves the set of regions known to the system.

getRegionSet

java.util.Set getRegionSet(java.util.Comparator pComparator)

Retrieves a set of regions that the user can see sorted based on the comparator given.

getStyleSet

java.util.Set getStyleSet()

Retrieves the set of styles known to the system.

getStyleSet

java.util.Set getStyleSet(java.util.Comparator pComparator)

Retrieves the set of styles known to the system sorted based on the comparator given.

getRootCommunityFolder

atg.portal.framework.folder.CommunityFolder getRootCommunityFolder()

Returns the root folder of the community folder tree.

getRootPageFolder

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

Returns the root folder of the page folder tree.

getRootGearDefinitionFolder

atg.portal.framework.folder.GearDefinitionFolder getRootGearDefinitionFolder()

Returns the root folder of the gear definition folder tree.

hasAccess

boolean hasAccess(AccessRight pRight)
           throws SecurityException

Returns true if the current user has the indicated access to this community.

Throws:

SecurityException

See Also:

PortalAccessRights, PortalAccessRights.PORTAL_RIGHTS

isLoggedIn

boolean isLoggedIn()

Returns true if the current user has logged in.

isPortalAdministrator

boolean isPortalAdministrator()

Returns true if the curren tuser is the portal administrator.

getPortalAdministratorRole

Role getPortalAdministratorRole()

Returns the user directory Role for the portal administrator.

getPortalAdministratorSecurityPrincipal

java.security.Principal getPortalAdministratorSecurityPrincipal()

Returns the security principal for the portal administrator.

getUserDirectory

UserDirectory getUserDirectory()

Returns the user directory that can be used for managing user identities, organizations, and roles.

getSecurityPrincipal

java.security.Principal getSecurityPrincipal(DirectoryPrincipal directoryPrincipal)

Converts a DirectoryPrincipal (any of the identity objects returned by the UserDirectory) into a security Principal. In some implementations this may return the same object.

getDirectoryPrincipal

DirectoryPrincipal getDirectoryPrincipal(java.security.Principal securityPrincipal)

Converts a security Principal into a user directory DirectoryPrincipal. In some implementations this may return the same object.

getCommunityRoleManager

atg.portal.framework.RelativeRoleManager getCommunityRoleManager()

Returns the relative role manager for community relative roles.

createFolder

atg.portal.framework.folder.Folder createFolder(java.lang.String pType,
                                                java.lang.String pFolderName,
                                                java.lang.String pFolderUrl,
                                                java.lang.String pParentFolder)
                                         throws PortalException,
                                                SecurityException

Creates a new folder with the parameters passed.

Throws:

PortalException

SecurityException

createColorPalette

ColorPalette createColorPalette(atg.portal.xml.configuration.PortalObjectConfiguration pConfig)
                         throws PortalException,
                                SecurityException

Creates a new color with the configuration item passed.

Throws:

PortalException

SecurityException

updateColorPalette

void updateColorPalette(ColorPalette pColor,
                        atg.portal.xml.configuration.PortalObjectConfiguration pConfig)
                 throws PortalException,
                        SecurityException

Updates a color palette with the configuration item passed.

Throws:

PortalException

SecurityException

createGearDefinition

GearDefinition createGearDefinition(atg.portal.xml.configuration.PortalObjectConfiguration pConfig)
                             throws PortalException,
                                    SecurityException

Creates a new gear definition with the configuration item passed.

Throws:

PortalException

SecurityException

updateGearDefinition

void updateGearDefinition(GearDefinition pGearDefinition,
                          atg.portal.xml.configuration.PortalObjectConfiguration pConfig)
                   throws PortalException,
                          SecurityException

Updates a gear definition with the configuration item passed.

Throws:

PortalException

SecurityException

deleteGearDefinition

void deleteGearDefinition(java.lang.String pGearDefinitionId)
                   throws PortalException,
                          SecurityException

Delete a gear definition with the id passed.

Throws:

PortalException

SecurityException

createStyle

Style createStyle(atg.portal.xml.configuration.PortalObjectConfiguration pConfig)
           throws PortalException,
                  SecurityException

Creates a new style with the configuration item passed.

Throws:

PortalException

SecurityException

updateStyle

void updateStyle(Style pStyle,
                 atg.portal.xml.configuration.PortalObjectConfiguration pConfig)
          throws PortalException,
                 SecurityException

Updates a style with the configuration item passed.

Throws:

PortalException

SecurityException

deleteStyle

void deleteStyle(java.lang.String pStyleName)
          throws PortalException,
                 SecurityException

Delete a style with the name passed.

Throws:

PortalException

SecurityException

createPageTemplate

PageTemplate createPageTemplate(atg.portal.xml.configuration.PortalObjectConfiguration pConfig)
                         throws PortalException,
                                SecurityException

Creates a new page template with the configuration item passed.

Throws:

PortalException

SecurityException

updatePageTemplate

void updatePageTemplate(PageTemplate pPageTemplate,
                        atg.portal.xml.configuration.PortalObjectConfiguration pConfig)
                 throws PortalException,
                        SecurityException

Updates a page template with the configuration item passed.

Throws:

PortalException

SecurityException

deletePageTemplate

void deletePageTemplate(java.lang.String pPageTemplateName)
                 throws PortalException,
                        SecurityException

Delete a page template with the name passed.

Throws:

PortalException

SecurityException

createLayoutTemplate

Layout createLayoutTemplate(atg.portal.xml.configuration.PortalObjectConfiguration pConfig)
                     throws PortalException,
                            SecurityException

Creates a new layout template with the configuration item passed.

Throws:

PortalException

SecurityException

updateLayoutTemplate

void updateLayoutTemplate(Layout pLayout,
                          atg.portal.xml.configuration.PortalObjectConfiguration pConfig)
                   throws PortalException,
                          SecurityException

Updates a layout template with the configuration item passed.

Throws:

PortalException

SecurityException

deleteLayoutTemplate

void deleteLayoutTemplate(java.lang.String pLayoutTemplateName)
                   throws PortalException,
                          SecurityException

Delete a layout template with the name passed.

Throws:

PortalException

SecurityException

createGearTemplate

atg.portal.framework.GearTitleTemplate createGearTemplate(atg.portal.xml.configuration.PortalObjectConfiguration pConfig)
                                                   throws PortalException,
                                                          SecurityException

Creates a new gear title template with the configuration item passed.

Throws:

PortalException

SecurityException

updateGearTemplate

void updateGearTemplate(atg.portal.framework.GearTitleTemplate pGearTitleTemplate,
                        atg.portal.xml.configuration.PortalObjectConfiguration pConfig)
                 throws PortalException,
                        SecurityException

Updates a gear title template with the configuration item passed.

Throws:

PortalException

SecurityException

deleteGearTemplate

void deleteGearTemplate(java.lang.String pGearTemplateName)
                 throws PortalException,
                        SecurityException

Delete a gear title template with the name passed.

Throws:

PortalException

SecurityException

createCommunity

Community createCommunity(java.lang.String pCommunityName,
                          java.lang.String pURL,
                          atg.portal.framework.folder.CommunityFolder pCommunityFolder)
                   throws PortalException,
                          SecurityException

Create a new Community with the given paramaters.

Parameters:

pCommunityName -

pURL -

pCommunityFolder -

Returns:

the community created

Throws:

PortalException

SecurityException

createCommunity

Community createCommunity(java.lang.String pCommmunityName,
                          java.lang.String pURL,
                          atg.portal.framework.folder.CommunityFolder pParentFolder,
                          java.lang.String pDescription,
                          java.lang.String pMembershipRequest,
                          PageTemplate pPageTemplate,
                          Style pStyle,
                          atg.portal.framework.GearTitleTemplate pGearTitleTemplate,
                          boolean pActive,
                          java.lang.String pPersonalizationLevel,
                          int pAccessLevel)
                   throws PortalException,
                          SecurityException

Create a new Community with the parameters passed in. Create a new community

Parameters:

pCommmunityName -

pURL -

pParentFolder -

pDescription -

pMembershipRequest -

pPageTemplate -

pStyle -

pGearTitleTemplate -

pActive -

pPersonalizationLevel -

pAccessLevel -

Returns:

Community created

Throws:

PortalException

SecurityException

createCommunity

Community createCommunity(java.lang.String pCommmunityName,
                          java.lang.String pURL,
                          atg.portal.framework.folder.CommunityFolder pParentFolder,
                          java.lang.String pDescription,
                          java.lang.String pMembershipRequest,
                          PageTemplate pPageTemplate,
                          Style pStyle,
                          atg.portal.framework.GearTitleTemplate pGearTitleTemplate,
                          boolean pActive,
                          java.lang.String pPersonalizationLevel,
                          int pAccessLevel,
                          Layout pLayout,
                          ColorPalette pColorPalette)
                   throws PortalException,
                          SecurityException

Create a community with the given parameters

Parameters:

pCommmunityName -

pURL -

pParentFolder -

pDescription -

pMembershipRequest -

pPageTemplate -

pStyle -

pGearTitleTemplate -

pActive -

pPersonalizationLevel -

pAccessLevel -

pLayout -

pColorPalette -

Returns:

Throws:

PortalException

SecurityException

deleteCommunity

boolean deleteCommunity(Community pCommunity)
                 throws PortalException,
                        SecurityException

Delete the given community

Parameters:

pCommunity -

Returns:

success indicator

Throws:

PortalException

SecurityException

createPersonalizedCommunityForPrincipal

atg.portal.framework.PersonalizedCommunity createPersonalizedCommunityForPrincipal(Community pSourceCommunity,
                                                                                   java.security.Principal pPrincipal)
                                                                            throws PortalException,
                                                                                   SecurityException

creates a PersonalizedCommunity

Parameters:

pSourceCommunity - The source community for the personalized community to create

pPrincipal - The Principals who will own the created PersonalizedCommunity

Throws:

PortalException - if there were any errors creating the PersonalizedCommunity.

SecurityException - in case of insufficient privileges to perform the opertation

createPersonalizedPageForPrincipal

PersonalizedPage createPersonalizedPageForPrincipal(Page pSourcePage,
                                                    java.security.Principal pPrincipal)
                                             throws PortalException,
                                                    SecurityException

creates a PersonalizedPage for the given Principal using pSourcePage as its source.

Parameters:

pSourcePage - The source page for the personalized page.

pPrincipal - The Principal who will own the created PersonalizedPage

Throws:

PortalException - if there were any errors creating the PersonalizedPage.

SecurityException - in case of insufficient privileges to perform the opertation

isReservedCommunityURL

boolean isReservedCommunityURL(java.lang.String pURLName)

Check if the given URL is the same as one of the reserverd community URLs

Parameters:

pName -

Returns:

getRepositoryItemId

java.lang.String getRepositoryItemId(java.lang.String pName,
                                     java.lang.String pType)
                              throws PortalException

Retrieves an Id of a portal object

Throws:

PortalException

getGearDefinitionId

java.lang.String getGearDefinitionId(java.lang.String pName,
                                     java.lang.String pAuthor)
                              throws PortalException

Retrieves an Id of a gear definition by name and author

Throws:

PortalException

getGearDefinitionId

java.lang.String getGearDefinitionId(java.lang.String pName,
                                     java.lang.String pAuthor,
                                     java.lang.String pVersion)
                              throws PortalException

Retrieves an Id of a gear definition by name, author and version

Throws:

PortalException

isChildCommunityFolder

boolean isChildCommunityFolder(java.lang.String pParent,
                               java.lang.String pChild)
                        throws PortalException

checks if the community folder is a child of the parent folder object

Throws:

PortalException

isChildGearDefinitionFolder

boolean isChildGearDefinitionFolder(java.lang.String pParent,
                                    java.lang.String pChild,
                                    java.lang.String pItemDescriptor)
                             throws PortalException

checks if the gear definition folder is a child of the parent folder object

Throws:

PortalException