atg.portal.framework
Interface Community

All Superinterfaces:

SecuredObject

public interface Community
extends SecuredObject

A community is a collection of portal users and content. A typical community shares a common purpose or hobby. The community might be a company department, such as a human resources group, or it might be a group of users with a common interest, such as a social group. Each community has its own portal pages, with content and functionality specific to the needs and interests of the community.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	COMMUNITY_LEVEL_PERSONALIZATION Identifier for community level personalization
static java.lang.String	GUEST_ROLE Identifier for guest role
static java.lang.String	LEADER_ROLE Identifier for leader role
static java.lang.String	MEMBER_ROLE Identifier for memeber role
static java.lang.String	MEMBERSHIP_REQUEST_ALLOW Identifier for allow membership request
static java.lang.String	MEMBERSHIP_REQUEST_AUTO Identifier for auto membership request
static java.lang.String	MEMBERSHIP_REQUEST_DISALLOW Identifier for disallow membership request
static java.lang.String	NO_PERSONALIZATION Identifier for no personalization
static java.lang.String	PAGE_LEVEL_PERSONALIZATION Identifier for page level personalization

Method Summary

Gear	addGear(GearDefinition pGearDefinition, java.lang.String pName, java.lang.String pDescription, boolean pShared, int pAccessLevel) Creates and adds a gear to this community with the given required properties
void	addGearInstance(Gear pGear) Adds a gear instance to the community.
void	assignRole(DirectoryPrincipal pPrincipal, java.lang.String pRoleName) Assigns a community relative role to the principal.
atg.portal.framework.CommunityTemplate	createCommunityTemplate(java.lang.String pName, java.lang.String pDescription) create a community template using this community as the basis for the template
MembershipRequest	createMembershipRequest(java.security.Principal pUser, java.lang.String pRequestType) create a membership request for this community
Page	createPage(java.lang.String pName, java.lang.String pURL, java.lang.String pDescription, int pPosition, boolean pMakeDefault, boolean pAllowCustomization, atg.portal.framework.folder.PageFolder pParentFolder, Layout pLayoutTemplate, ColorPalette pColorPalette) Create a new non personalized page with the given values in the given community
void	deleteMembershipRequest(java.security.Principal pPrincipal) Remove the membership request made by the given Principal for the given community.
boolean	deletePage(Page pPage) Deletes a page
atg.portal.framework.Template	getAccessDeniedTemplate() Access the communities access denied template
int	getAccessLevel() Access the community's Access Level
java.lang.String	getCommunityPath() Access the path of the community in the community folder tree
java.lang.String	getCommunityURI() Access the community uri
java.util.Date	getCreationDate() Access the creation date of the community
Page	getDefaultPage() Access the default community page
java.lang.String	getDescription() Deprecated.
java.lang.String	getDescription(java.util.Locale locale) Access the localized form of the community description, returning a default if one is not available.
java.lang.String	getFullyQualifiedRoleName(java.lang.String pRoleName) Deprecated.
atg.portal.framework.folder.GearDefinitionFolder[]	getGearDefinitionFolders() Deprecated.
java.util.Set	getGearDefinitionFolderSet() Access the community's allowed gear definition folders as java.util.Set
java.util.Set	getGearDefinitionFolderSet(java.util.Comparator pComparator) Returns the gear definition folders assigned for use by communities in this folder sorted based on the given comparator.
java.util.Set	getGears() Deprecated.
java.util.Set	getGearSet() Access the gears in the community
java.util.Set	getGearSet(java.util.Comparator pComparator) Access the gears in the community sorted based on the given comparator if pComparator is null gears are returned unsorted.
java.util.Set	getGearsShared() Access the gears shared by this community or its source community if the community is personalized.
java.util.Set	getGearsShared(java.util.Comparator pComparator) Access the gears shared by this community or its source community if the community is personalized.
GearTitleBarDefinition	getGearTitleBarDefinition() Access the community's Gear TitleBar Definition
atg.portal.framework.GearTitleTemplate	getGearTitleTemplate() Access the community's Gear Title Template
java.lang.String	getId() Access the id of the community
atg.portal.framework.Template	getInactiveTemplate() Access the communities inactive template
java.util.Date	getLastModified() Access the last modified date of the community
atg.portal.framework.Template	getLoginTemplate() Access the communities login template
atg.portal.framework.Template	getLogoutTemplate() Access the communities logout template
java.util.Set	getMembershipRequestSet() get set of membership requests
java.lang.String	getName() Deprecated.
java.lang.String	getName(java.util.Locale locale) Access the localized form of the community name, returning a default if one is not available.
Page[]	getPages() Deprecated.
java.util.Set	getPageSet() Returns a set of pages contained in this community.
java.util.Set	getPageSet(java.util.Comparator pComparator) Returns a set of pages contained in this community sorted using the comparator.
PageTemplate	getPageTemplate() Access the community's Page Template
atg.portal.framework.folder.CommunityFolder	getParentFolder() Access the community's parent folder
java.util.Set	getPersonalizedCommunitySet() get all the personalized communities tha have this community as the source community
Portal	getPortal() Returns the portal that this community is a part of.
atg.portal.framework.Template	getRegistrationTemplate() Access the communities registration template
Role	getRole(java.lang.String pName) Returns the user directory Role associated with the supplied community relative role name.
atg.portal.framework.folder.PageFolder	getRootPageFolder() Returns the root page folder for this community.
java.security.Principal	getSecurityPrincipal(java.lang.String pName) Returns the principal associated with the supplied community relative role name.
Style	getStyle() Access the style for the community
atg.portal.framework.Template	getUpdateProfileTemplate() Access the communities update profile template
java.lang.String	getURLName() Access the url of the community
Page	getWirelessPage() Access the community's Wireless Enabled Page
boolean	hasAccess(AccessRight pRight) Returns true if the current user has the indicated access to this community.
boolean	hasAccess(BaseEnvironment pEnv) Deprecated.
java.lang.String	hasGearFolder(java.lang.String pFolderId) Returns true if the community has the folder in gearFolders property
boolean	hasRole(java.lang.String communityRole) Returns true if the user has the named community relative role.
boolean	isAllowMembershipRequest() True if the community allows membership request
java.lang.String	isAllowMembershipRequestString() True if the community allows membership request
boolean	isAllowPersonalizedCommunities() True if the community is allowed to be personalized
boolean	isAllowPersonalizedPages() True if the community allows personalized pages
boolean	isAutoMembershipRequest() True is membership requests is automatic
boolean	isEnabled() Returns true if the community is enabled
java.lang.String	isEnabledString() Returns true if the community is enabled
boolean	isGuest() Returns true if the current user is a guest, member, community leader, or portal administrator.
boolean	isGuest(Environment pEnv) Deprecated.
boolean	isLeader() Returns true if the user is a community leader or the portal administrator.
boolean	isLeader(Environment pEnv) Deprecated.
boolean	isMember() Returns true if the user is a member, community leader, or portal administrator.
boolean	isMember(Environment pEnv) Deprecated.
boolean	isPersonalizedCommunity() True if the community a personalized community
void	removeGear(Gear pGear) Remove the gear(pGear) from the this community.
void	revokeRole(DirectoryPrincipal pPrincipal, java.lang.String pAccesType) Revokes a community relative role from the principal.
void	setAccessLevel(int pAccessLevel) Sets the community's Access Level
void	setAllowMembershipRequest(boolean pAllowMembershipRequest) Sets if the community allows membership request
void	setAllowPersonalizedCommunities(boolean pAllowPersonalizedCommunities) Sets whether the community should allow personalized communities
void	setAllowPersonalizedPages(boolean pAllowPersonalizedPages) Sets whether the community should allow personalized pages
void	setAutoMembershipRequest(boolean pAutoMembershipRequest) Sets if membership requests is automatic
void	setDefaultPage(Page pPage) Make the given page the default page of this community
void	setDescription(java.lang.String pDescription) Sets the description of the community
void	setDescription(java.lang.String pDescription, java.util.Locale pLocale) Sets the description of the community for the given locale
void	setEnabled(boolean pEnabled) Sets the active status of the community
void	setGearDefinitionFolders(atg.portal.framework.folder.GearDefinitionFolder[] pGearDefinitionFolder) Sets the community's allowed gear definition folders
void	setGearTitleTemplate(atg.portal.framework.GearTitleTemplate pGearTitleTemplate) Sets the community's Gear Title Template
void	setName(java.lang.String pName) Set the name of the community
void	setName(java.lang.String pURLName, java.util.Locale pLocale) Sets the url of the community
void	setPageTemplate(PageTemplate pPageTemplate) Sets the community's Page Template
void	setParentFolder(atg.portal.framework.folder.CommunityFolder pParentFolder) Access the community's parent folder
void	setStyle(Style pStyle) Sets the style for the community
void	setURLName(java.lang.String pURLName) Sets the url of the community
void	setWirelessPage(Page pWirelessPage) Access the community's Wireless Enabled Page

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

LEADER_ROLE

static final java.lang.String LEADER_ROLE

Identifier for leader role

See Also:

Constant Field Values

MEMBER_ROLE

static final java.lang.String MEMBER_ROLE

Identifier for memeber role

See Also:

Constant Field Values

GUEST_ROLE

static final java.lang.String GUEST_ROLE

Identifier for guest role

See Also:

Constant Field Values

COMMUNITY_LEVEL_PERSONALIZATION

static final java.lang.String COMMUNITY_LEVEL_PERSONALIZATION

Identifier for community level personalization

See Also:

Constant Field Values

PAGE_LEVEL_PERSONALIZATION

static final java.lang.String PAGE_LEVEL_PERSONALIZATION

Identifier for page level personalization

See Also:

Constant Field Values

NO_PERSONALIZATION

static final java.lang.String NO_PERSONALIZATION

Identifier for no personalization

See Also:

Constant Field Values

MEMBERSHIP_REQUEST_AUTO

static final java.lang.String MEMBERSHIP_REQUEST_AUTO

Identifier for auto membership request

See Also:

Constant Field Values

MEMBERSHIP_REQUEST_ALLOW

static final java.lang.String MEMBERSHIP_REQUEST_ALLOW

Identifier for allow membership request

See Also:

Constant Field Values

MEMBERSHIP_REQUEST_DISALLOW

static final java.lang.String MEMBERSHIP_REQUEST_DISALLOW

Identifier for disallow membership request

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Access the id of the community

Returns:

an id

getPortal

Portal getPortal()

Returns the portal that this community is a part of.

getURLName

java.lang.String getURLName()

Access the url of the community

Returns:

a url

setURLName

void setURLName(java.lang.String pURLName)

Sets the url of the community

getName

java.lang.String getName()

Deprecated.

Access the name of the community

Returns:

a name

See Also:

getLocalizedName

setName

void setName(java.lang.String pName)

Set the name of the community

Parameters:

a - url

getName

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

Access the localized form of the community name, returning a default if one is not available.

setName

void setName(java.lang.String pURLName,
             java.util.Locale pLocale)

Sets the url of the community

getDescription

java.lang.String getDescription()

Deprecated.

Access the description for the community

Returns:

a description

See Also:

getLocalizedDescription

setDescription

void setDescription(java.lang.String pDescription)

Sets the description of the community

getDescription

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

Access the localized form of the community description, returning a default if one is not available.

setDescription

void setDescription(java.lang.String pDescription,
                    java.util.Locale pLocale)

Sets the description of the community for the given locale

getCommunityPath

java.lang.String getCommunityPath()

Access the path of the community in the community folder tree

Returns:

a community path

getCreationDate

java.util.Date getCreationDate()

Access the creation date of the community

Returns:

a date

getLastModified

java.util.Date getLastModified()

Access the last modified date of the community

Returns:

a date

isEnabled

boolean isEnabled()

Returns true if the community is enabled

Returns:

Returns true if the community is enabled, false otherwise

setEnabled

void setEnabled(boolean pEnabled)

Sets the active status of the community

isEnabledString

java.lang.String isEnabledString()

Returns true if the community is enabled

Returns:

Returns true if the community is enabled, false otherwise

hasGearFolder

java.lang.String hasGearFolder(java.lang.String pFolderId)

Returns true if the community has the folder in gearFolders property

Returns:

Returns true if the community has the folder in gearFolders property, false otherwise.

getRootPageFolder

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

Returns the root page folder for this community.

getPages

Page[] getPages()

Deprecated.

Returns an array of pages contained in this community. This method has been deprecated in favor of pagePageSet().

Returns:

an array of pages

See Also:

Page, getPageSet()

getPageSet

java.util.Set getPageSet()

Returns a set of pages contained in this community.

Returns:

a set of pages

See Also:

Page

getPageSet

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

Returns a set of pages contained in this community sorted using the comparator.

Returns:

a set of pages

See Also:

Page

getDefaultPage

Page getDefaultPage()

Access the default community page

Returns:

a page

See Also:

Page

setDefaultPage

void setDefaultPage(Page pPage)

Make the given page the default page of this community

See Also:

Page

getGears

java.util.Set getGears()

Deprecated.

Access the gears in the community

Returns:

a set of gears

See Also:

Gear, getGearSet()

getGearSet

java.util.Set getGearSet()

Access the gears in the community

Returns:

a set of gears

See Also:

Gear

getGearsShared

java.util.Set getGearsShared()

Access the gears shared by this community or its source community if the community is personalized.

Returns:

a set of gears

See Also:

Gear

getGearsShared

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

Access the gears shared by this community or its source community if the community is personalized. Gears are sorted based on the comparator given.

Returns:

a set of gears

See Also:

Gear

getGearSet

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

Access the gears in the community sorted based on the given comparator if pComparator is null gears are returned unsorted.

Returns:

a set of gears

See Also:

Gear

getStyle

Style getStyle()

Access the style for the community

Returns:

a style

See Also:

Style

setStyle

void setStyle(Style pStyle)

Sets the style for the community

See Also:

Style

isAllowPersonalizedPages

boolean isAllowPersonalizedPages()

True if the community allows personalized pages

Returns:

true if the community allows personalized pages, false otherwise

setAllowPersonalizedPages

void setAllowPersonalizedPages(boolean pAllowPersonalizedPages)

Sets whether the community should allow personalized pages

isAllowPersonalizedCommunities

boolean isAllowPersonalizedCommunities()

True if the community is allowed to be personalized

Returns:

true if the community is allowed to be personalized, false otherwise

setAllowPersonalizedCommunities

void setAllowPersonalizedCommunities(boolean pAllowPersonalizedCommunities)

Sets whether the community should allow personalized communities

isPersonalizedCommunity

boolean isPersonalizedCommunity()

True if the community a personalized community

Returns:

true if this community a personalized community, false otherwise

isAllowMembershipRequest

boolean isAllowMembershipRequest()

True if the community allows membership request

Returns:

true if the community allows membership request, false otherwise

isAllowMembershipRequestString

java.lang.String isAllowMembershipRequestString()

True if the community allows membership request

Returns:

true if the community allows membership request, false otherwise

setAllowMembershipRequest

void setAllowMembershipRequest(boolean pAllowMembershipRequest)

Sets if the community allows membership request

isAutoMembershipRequest

boolean isAutoMembershipRequest()

True is membership requests is automatic

Returns:

true is membership requests is automatic, false otherwise

setAutoMembershipRequest

void setAutoMembershipRequest(boolean pAutoMembershipRequest)

Sets if membership requests is automatic

getCommunityURI

java.lang.String getCommunityURI()

Access the community uri

Returns:

a uri

getFullyQualifiedRoleName

java.lang.String getFullyQualifiedRoleName(java.lang.String pRoleName)

Deprecated.

Access a fully qualified role name. This method has been deprecated in favor of getRole().

Parameters:

pRoleName - a role name

Returns:

a role name in its mangled form

See Also:

getRole(java.lang.String)

getPersonalizedCommunitySet

java.util.Set getPersonalizedCommunitySet()

get all the personalized communities tha have this community as the source community

Returns:

Set of PersonalizedCommunities

See Also:

PersonalizedCommunity

isLeader

boolean isLeader(Environment pEnv)

Deprecated.

Returns true if the user is a community leader or the portal administrator. This method has been deprecated in favor of isLeader() (no arguments). The pEnv argument does nothing in this version.

Parameters:

pEnv - an environment

Returns:

true if user is a leader/administrator, false otherwise

See Also:

isMember(atg.portal.framework.Environment), isGuest(atg.portal.framework.Environment), Portal.isPortalAdministrator, Portal.isRegisteredUser

isLeader

boolean isLeader()

Returns true if the user is a community leader or the portal administrator.

Returns:

true if user is a leader/administrator, false otherwise

See Also:

isMember(atg.portal.framework.Environment), isGuest(atg.portal.framework.Environment), Portal.isPortalAdministrator, Portal.isRegisteredUser

isMember

boolean isMember(Environment pEnv)

Deprecated.

Returns true if the user is a member, community leader, or portal administrator. This method has been deprecated in favor of isMember() (no arguments). The pEnv argument does nothing in this version.

Parameters:

pEnv - an environment

Returns:

true if user is a member/leader/administrator, false otherwise

See Also:

isLeader(atg.portal.framework.Environment), isGuest(atg.portal.framework.Environment), Portal.isPortalAdministrator, Portal.isRegisteredUser

isMember

boolean isMember()

Returns true if the user is a member, community leader, or portal administrator.

Returns:

true if user is a member/leader/administrator, false otherwise

See Also:

isLeader(atg.portal.framework.Environment), isGuest(atg.portal.framework.Environment), Portal.isPortalAdministrator, Portal.isRegisteredUser

isGuest

boolean isGuest(Environment pEnv)

Deprecated.

Returns true if the current user is a guest, member, community leader, or portal administrator. This method has been deprecated in favor of isGuest() (no arguments). The pEnv argument does nothing in this version.

Parameters:

pEnv - an environment

Returns:

true if user is a guest, false otherwise

See Also:

isLeader(atg.portal.framework.Environment), isMember(atg.portal.framework.Environment), Portal.isPortalAdministrator, Portal.isRegisteredUser

isGuest

boolean isGuest()

Returns true if the current user is a guest, member, community leader, or portal administrator.

Returns:

true if user is a guest/member/leader/administrator, false otherwise

See Also:

isLeader(atg.portal.framework.Environment), isMember(atg.portal.framework.Environment), Portal.isPortalAdministrator, Portal.isRegisteredUser

hasRole

boolean hasRole(java.lang.String communityRole)

Returns true if the user has the named community relative role.

See Also:

Portal.getCommunityRoleManager, getRole(java.lang.String), getSecurityPrincipal(java.lang.String)

getRole

Role getRole(java.lang.String pName)

Returns the user directory Role associated with the supplied community relative role name.

Parameters:

pName - Name of a community relative role

Returns:

A user directory Role representing the role

See Also:

Portal.getCommunityRoleManager, hasRole(java.lang.String), getSecurityPrincipal(java.lang.String)

getSecurityPrincipal

java.security.Principal getSecurityPrincipal(java.lang.String pName)

Returns the principal associated with the supplied community relative role name.

Parameters:

pName - Name of a community relative role

Returns:

A security principal representing the role

See Also:

Portal.getCommunityRoleManager, hasRole(java.lang.String), getRole(java.lang.String)

hasAccess

boolean hasAccess(BaseEnvironment pEnv)

Deprecated.

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

Parameters:

pEnv - an environment

Returns:

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

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.COMMUNITY_RIGHTS

getPageTemplate

PageTemplate getPageTemplate()

Access the community's Page Template

Returns:

a page title template definition

See Also:

PageTemplate

setPageTemplate

void setPageTemplate(PageTemplate pPageTemplate)

Sets the community's Page Template

getLoginTemplate

atg.portal.framework.Template getLoginTemplate()

Access the communities login template

Returns:

a template definition

See Also:

Template

getLogoutTemplate

atg.portal.framework.Template getLogoutTemplate()

Access the communities logout template

Returns:

a template definition

See Also:

Template

getAccessDeniedTemplate

atg.portal.framework.Template getAccessDeniedTemplate()

Access the communities access denied template

Returns:

a template definition

See Also:

Template

getRegistrationTemplate

atg.portal.framework.Template getRegistrationTemplate()

Access the communities registration template

Returns:

a template definition

See Also:

Template

getUpdateProfileTemplate

atg.portal.framework.Template getUpdateProfileTemplate()

Access the communities update profile template

Returns:

a template definition

See Also:

Template

getInactiveTemplate

atg.portal.framework.Template getInactiveTemplate()

Access the communities inactive template

Returns:

a template definition

See Also:

Template

getGearTitleTemplate

atg.portal.framework.GearTitleTemplate getGearTitleTemplate()

Access the community's Gear Title Template

Returns:

a gear title template definition

See Also:

GearTitleTemplate

setGearTitleTemplate

void setGearTitleTemplate(atg.portal.framework.GearTitleTemplate pGearTitleTemplate)

Sets the community's Gear Title Template

See Also:

GearTitleTemplate

getGearTitleBarDefinition

GearTitleBarDefinition getGearTitleBarDefinition()

Access the community's Gear TitleBar Definition

Returns:

a gear titlebar definition

See Also:

GearTitleBarDefinition

getGearDefinitionFolders

atg.portal.framework.folder.GearDefinitionFolder[] getGearDefinitionFolders()

Deprecated.

Access the community's allowed gear definition folders. This method is deprecated in favor of method getGearDefinitionFolderSet.

Returns:

the set of gear definition folders allowed for this community

See Also:

GearDefinitionFolder

getGearDefinitionFolderSet

java.util.Set getGearDefinitionFolderSet()

Access the community's allowed gear definition folders as java.util.Set

Returns:

the set of gear definition folders allowed for this community

getGearDefinitionFolderSet

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

Returns the gear definition folders assigned for use by communities in this folder sorted based on the given comparator.

Parameters:

the - comparator to use for sorting the collection of GearDefinitionFolders

Returns:

the set of gear definition folders allowed for this community

setGearDefinitionFolders

void setGearDefinitionFolders(atg.portal.framework.folder.GearDefinitionFolder[] pGearDefinitionFolder)

Sets the community's allowed gear definition folders

See Also:

GearDefinitionFolder

getAccessLevel

int getAccessLevel()

Access the community's Access Level

setAccessLevel

void setAccessLevel(int pAccessLevel)

Sets the community's Access Level

getWirelessPage

Page getWirelessPage()

Access the community's Wireless Enabled Page

Returns:

the page

See Also:

Page

setWirelessPage

void setWirelessPage(Page pWirelessPage)

Access the community's Wireless Enabled Page

See Also:

Page

getParentFolder

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

Access the community's parent folder

Returns:

the folder

See Also:

Folder

setParentFolder

void setParentFolder(atg.portal.framework.folder.CommunityFolder pParentFolder)

Access the community's parent folder

See Also:

Page

assignRole

void assignRole(DirectoryPrincipal pPrincipal,
                java.lang.String pRoleName)

Assigns a community relative role to the principal.

Parameters:

pPrincipal - Principal to assign access to.

pRoleName - The name of the community relative role to provide to the principal.

revokeRole

void revokeRole(DirectoryPrincipal pPrincipal,
                java.lang.String pAccesType)

Revokes a community relative role from the principal.

Parameters:

pPrincipal - Principal to revoke access from.

pRoleName - The name of the community relative role to provide to the principal.

createCommunityTemplate

atg.portal.framework.CommunityTemplate createCommunityTemplate(java.lang.String pName,
                                                               java.lang.String pDescription)
                                                               throws CommunitySpawnException

create a community template using this community as the basis for the template

Parameters:

pCommunityTemplateName - the name of the template to be generated

Returns:

a CommunityTemplate object with values set to the current configuration of this community object

Throws:

CommunitySpawnException - if there was an error creating the community template

createMembershipRequest

MembershipRequest createMembershipRequest(java.security.Principal pUser,
                                          java.lang.String pRequestType)

create a membership request for this community

Parameters:

pUser - the principal to create the membership request for

pRequestType - the type for this request

Returns:

a MembershipRequest object with values set to thbe current configuration of this community object

getMembershipRequestSet

java.util.Set getMembershipRequestSet()

get set of membership requests

Returns:

a Set of membership requests

deleteMembershipRequest

void deleteMembershipRequest(java.security.Principal pPrincipal)
                             throws PortalException,
                                    SecurityException

Remove the membership request made by the given Principal for the given community.

Parameters:

pPrincipal - the principal which has made the membership request

Throws:

PortalException - if an error occurs deleting the membership request.

SecurityException

addGear

Gear addGear(GearDefinition pGearDefinition,
             java.lang.String pName,
             java.lang.String pDescription,
             boolean pShared,
             int pAccessLevel)
             throws PortalException,
                    SecurityException

Creates and adds a gear to this community with the given required properties

Parameters:

pGearDefinition - the GearDefinition to use for creating the gear

pShared - if the gears should be shared across communities

pDescription - the gear's description

pAccessLevel - the access level for the new gear

Throws:

PortalException - if there were any errors creating the gear.

SecurityException

addGearInstance

void addGearInstance(Gear pGear)
                     throws PortalException,
                            SecurityException

Adds a gear instance to the community. The gear must be made sharable by its parent community.

Parameters:

pGear - the Gear to add

Throws:

PortalException - if there were any errors creating the gear.

SecurityException

removeGear

void removeGear(Gear pGear)
                throws PortalException,
                       SecurityException

Remove the gear(pGear) from the this community. The gear instance will be permanently deleted if this community is the parent community of the gear instance(pGear) otherwise just the reference to the gear will be removed.

Parameters:

pGear - the Gear to remove

Throws:

PortalException - if there were any errors removing the gear.

SecurityException - if current user is not allowed to perform the operation.

createPage

Page createPage(java.lang.String pName,
                java.lang.String pURL,
                java.lang.String pDescription,
                int pPosition,
                boolean pMakeDefault,
                boolean pAllowCustomization,
                atg.portal.framework.folder.PageFolder pParentFolder,
                Layout pLayoutTemplate,
                ColorPalette pColorPalette)
                throws PortalException,
                       SecurityException

Create a new non personalized page with the given values in the given community

Parameters:

pName - Page' name

pURL - Page's URL

pDescription - Page's description

pPosition - Page's position

pMakeDefault - Whether to make this the default page of the given community

pAllowCustomization - Whether to allow users to customize this page

pParentFolder - The PageFolder to include the page in

pLayoutTemplate - The LayoutTemplate to use. If null the LayoutTemplate of the default page of the given community.

pColorPalette - The ColorPalette to use. If null the ColorPalette of the default page of the given community.

Returns:

Success indicator

Throws:

PortalException - If an error occurs creating the page

SecurityException - if the current user does not have the required privileges.

deletePage

boolean deletePage(Page pPage)
                   throws PortalException,
                          SecurityException

Deletes a page

Parameters:

pPage - The page to delete

Throws:

PortalException - if there were any errors deleting the page.

SecurityException - in case of insufficient privileges to perform the opertation