com.plumtree.server
Interface IPTCommunity

All Superinterfaces:

IPTLocalizable, IPTObject, IPTPageContainer, IPTPreferencesContext, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTCommunity
extends IPTPageContainer

Version:

$Revision$

Author:

Robert Zhang, Michael DeCourcey

Method Summary

void	AddMandatoryGroupMember(int nGroupID, int nMemberType) Doesn't actually add a group as mandatory member since groups are always mandatory.
int	AddPage(java.lang.String strPageName, int nPageType, int nPageTemplateID, int nFromCommunityTemplate) Deprecated. Method AddPage(String, int, int, int) is deprecated. Use IPTPageContainer.AddPage(int) instead.
int	GetCommunityTemplateID() Get the community template ID assigned to this community.
int	GetFooterID() Gets the footer ID assigned to this community.
int	GetHeaderID() Gets the header ID assigned to this community.
boolean	GetInheritCommunityTemplate()
int	GetMandatoryTabOrder() Get the mandatory community tab priority assigned for this community.
java.lang.String	GetOwnerInfo() Get the owner info for this community.
boolean	GetSiteMapDisabled() Checks if the community sitemap is disabled for this community.
IPTSiteMapFolder	GetSiteMapRoot() Get the root sitemap folder for this community
IPTMyPortal	OpenPage(int nPageID) Deprecated. Method OpenPage is deprecated. Use IPTPageContainer.GetPage instead. IPTCommunity extends IPTPageContainer.
IPTQueryResult	QueryMembers(int nMemberType) Get either the users or groups who are members of this community.
IPTQueryResult	QuerySubcommunities() Queries for Subcommunities in the current community that the current user has at least READ access to.
void	RemoveMandatoryGroupMember(int nGroupID) Removes a group from this community's membership list, note that the group's ACL will still remain unchanged.
void	RemovePage(int nPageID) Deprecated. RemovePage is deprecated. Use IPTPageManager.Delete(nPageID) instead.
void	ResetPageName(int nPageID, java.lang.String strPageName) Deprecated. Method ResetPageName is deprecated. Use IPTPage.SetName instead.
void	ResetPagePageTemplateID(int nPageID, int nPageTemplateID) Deprecated. Method ResetPagePageTemplateID is deprecated. Use IPTPage.SetPageTemplateID instead.
void	ResetPageType(int nPageID, int nPageType) Deprecated. Method ResetPageType is deprecated. Use IPTPage.SetPageType instead.
void	ResetPageURL(int nPageID, java.lang.String strURL) Deprecated. - URL can no longer be set on Pages
void	SetCommunityTemplateID(int nCommunityTemplateID) Assigns a community template to this community.
void	SetFooterID(int nFooterID) Assigns new Footer ID to this community.
void	SetHeaderID(int nHeaderID) Assigns new Header ID to this community.
void	SetInheritCommunityTemplate(boolean bInheritCommunityTemplate) Set whether the Community should inherit the settings of the Community Template.
void	SetMandatoryTabOrder(int nMandatoryTabOrder) Assigns new mandatory community tab priority for this community.
void	SetOwnerInfo(java.lang.String strOwnerInfo) Assigns new owner info for this community.
void	SetSiteMapDisabled(boolean bValue) Sets flag to disable sitemap.

Methods inherited from interface com.plumtree.server.IPTPageContainer

AssignPages, AssignPages, GetPage, QueryPages

Methods inherited from interface com.plumtree.server.IPTPreferencesContext

AddPreference, AddPreference, AddPreference, AddPreference, AddPreference, AssignPreferences, LookupPreference, LookupPreferences, RemovePreference, RemovePreferences

Methods inherited from interface com.plumtree.server.IPTObject

GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified

Methods inherited from interface com.plumtree.server.IPTLocalizable

GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Methods inherited from interface com.plumtree.server.IPTServerContext

GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, GetSettings, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject

Methods inherited from interface com.plumtree.server.IPTStorable

Store

Method Detail

AddPage

int AddPage(java.lang.String strPageName,
            int nPageType,
            int nPageTemplateID,
            int nFromCommunityTemplate)

Deprecated. Method AddPage(String, int, int, int) is deprecated. Use IPTPageContainer.AddPage(int) instead.

Add a page to the page container.

Parameters:

strPageName - Name of page

nPageType - One of the constants defined in PT_PAGE_TYPES, right now only PT_PAGETYPE_REGULAR

nPageTemplateID - PageTemplateID

nFromCommunityTemplate - 1 if the pagetemplate is in a communitytemplate, 0 or less otherwise

See Also:

PT_PAGE_TYPES

RemovePage

void RemovePage(int nPageID)

Deprecated. RemovePage is deprecated. Use IPTPageManager.Delete(nPageID) instead.

Removing a page requires at least EDIT access to the page container.

Parameters:

nPageID - ID of the page to remove

Throws:

java.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS errorcode if the user has insufficient access to the community

OpenPage

IPTMyPortal OpenPage(int nPageID)

Deprecated. Method OpenPage is deprecated. Use IPTPageContainer.GetPage instead. IPTCommunity extends IPTPageContainer.

Gets the PTMyPortal object for the specified page

Parameters:

nPageID - Page ID

Returns:

IPTMyPortal for the specfied page

Throws:

java.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS errorcode if the user has insufficient access to the community

QueryMembers

IPTQueryResult QueryMembers(int nMemberType)

Get either the users or groups who are members of this community.

Parameters:

nMemberType - Either PT_CLASSIDS.PT_USER_ID or PT_CLASSIDS.PT_USERGROUP_ID

Returns:

User or group members of this community

See Also:

PT_CLASSIDS

QuerySubcommunities

IPTQueryResult QuerySubcommunities()

Queries for Subcommunities in the current community that the current user has at least READ access to.

Returns:

IPTQueryResult with PT_PROPIDS.PT_PROPID_OBJECTID, PT_PROPIDS.PT_PROPID_NAME, PT_PROPIDS.PT_PROPID_DESCRIPTION, PT_PROPIDS.PT_PROPID_ISLOCALIZED, PT_PROPIDS.PT_PROPID_FOLDERID, PT_PROPIDS.PT_PROPID_ACCESSLEVEL

AddMandatoryGroupMember

void AddMandatoryGroupMember(int nGroupID,
                             int nMemberType)

Doesn't actually add a group as mandatory member since groups are always mandatory. Use to turn on or off a mandatory community tab in the navigation for the specified group. Only groups and no users can be added as mandatory member and need at least EDIT access level to the group object and this community.

Parameters:

nGroupID - Only positive IDs, i.e. negative IDs for users are not accepted.

nMemberType - Either PT_COMMUNITY_MEMBERSHIPTYPE.PT_COMMUNITYMEMBER_TAB or PT_COMMUNITY_MEMBERSHIPTYPE.PT_COMMUNITYMEMBER_MANDATORY. Groups cannot be set to PT_COMMUNITY_MEMBERSHIPTYPE.PT_COMMUNITYMEMBER_FREE.

See Also:

PT_COMMUNITY_MEMBERSHIPTYPE

RemoveMandatoryGroupMember

void RemoveMandatoryGroupMember(int nGroupID)

Removes a group from this community's membership list, note that the group's ACL will still remain unchanged. The group will still have access to a community even when not a member, remove the group from the ACL to deny access to the community. Removing a group requires both EDIT access to the community and the group objects.

Parameters:

nGroupID - ID of the group to remove, users (negative IDs) are not accepted.

Throws:

java.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS errorcode if the user has insufficient access to the community

GetOwnerInfo

java.lang.String GetOwnerInfo()

Get the owner info for this community.

Returns:

Ownerinfo

SetOwnerInfo

void SetOwnerInfo(java.lang.String strOwnerInfo)

Assigns new owner info for this community.

Parameters:

strOwnerInfo - New owner info

GetMandatoryTabOrder

int GetMandatoryTabOrder()

Get the mandatory community tab priority assigned for this community.

Returns:

Mandatory Community tab priority

SetMandatoryTabOrder

void SetMandatoryTabOrder(int nMandatoryTabOrder)

Assigns new mandatory community tab priority for this community.

Parameters:

nMandatoryTabOrder - One of the mandatory community tab priority defined in PT_MANDATORYORDERING

See Also:

PT_MANDATORYORDERING

ResetPageName

void ResetPageName(int nPageID,
                   java.lang.String strPageName)

Deprecated. Method ResetPageName is deprecated. Use IPTPage.SetName instead.

Renames a page, maximum page length is defined by PT_SERVERCONSTANTS.PT_MAX_PAGENAMELENGTH Requires EDIT access on the community.

Parameters:

nPageID - ID of the page to rename

strPageName - New page name

Throws:

java.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS errorcode if the user has insufficient access to the community

See Also:

PT_SERVERCONSTANTS.PT_MAX_PAGENAMELENGTH

ResetPageURL

void ResetPageURL(int nPageID,
                  java.lang.String strURL)

Deprecated. - URL can no longer be set on Pages

ResetPageType

void ResetPageType(int nPageID,
                   int nPageType)

Deprecated. Method ResetPageType is deprecated. Use IPTPage.SetPageType instead.

Assigns a new pagetype for the specified page. Requires EDIT access to the community.

Parameters:

nPageID - ID of page to assign new pagetype to

nPageType - New pagetype for the specified page

GetSiteMapRoot

IPTSiteMapFolder GetSiteMapRoot()

Get the root sitemap folder for this community

Returns:

Root sitemap folder object

ResetPagePageTemplateID

void ResetPagePageTemplateID(int nPageID,
                             int nPageTemplateID)

Deprecated. Method ResetPagePageTemplateID is deprecated. Use IPTPage.SetPageTemplateID instead.

Set a new pagetemplate for specified page. Requires EDIT access to the community and SELECT on the pagetemplate.

Parameters:

nPageID - ID of Page to assign new pagetemplate to

nPageTemplateID - ID of new pagetemplate for the specified page

Throws:

java.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS if the user has insufficient access to the community

GetCommunityTemplateID

int GetCommunityTemplateID()

Get the community template ID assigned to this community.

Returns:

Community template ID assigned to this community

SetCommunityTemplateID

void SetCommunityTemplateID(int nCommunityTemplateID)

Assigns a community template to this community.

Parameters:

nCommunityTemplateID - ID of the new community template

Throws:

java.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS errorcode if the user has insufficient access to the community

GetHeaderID

int GetHeaderID()

Gets the header ID assigned to this community.

Returns:

Header ID assigned to this community

SetHeaderID

void SetHeaderID(int nHeaderID)

Assigns new Header ID to this community. Requires SELECT on the header gadget.

Parameters:

nHeaderID - ID of a header gadget

Throws:

java.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS errorcode if the user has insufficient access to the community

GetFooterID

int GetFooterID()

Gets the footer ID assigned to this community.

Returns:

Footer ID assigned to this community

SetFooterID

void SetFooterID(int nFooterID)

Assigns new Footer ID to this community. Requires SELECT on the footer gadget.

Parameters:

nFooterID - ID of a footer gadget

Throws:

java.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS errorcode if the user has insufficient access to the community

GetSiteMapDisabled

boolean GetSiteMapDisabled()

Checks if the community sitemap is disabled for this community.

Returns:

true if sitemap is disabled, false otherwise

SetSiteMapDisabled

void SetSiteMapDisabled(boolean bValue)

Sets flag to disable sitemap.

Parameters:

bValue - true to disable sitemap in this community, false to enable

GetInheritCommunityTemplate

boolean GetInheritCommunityTemplate()

Returns:

whether the Community should inherit the settings of the Community Template. If it returns false, then the Community copied the current settings of the Community Template and it will not inherit future changes to the page template.

SetInheritCommunityTemplate

void SetInheritCommunityTemplate(boolean bInheritCommunityTemplate)

Set whether the Community should inherit the settings of the Community Template. It is true by default. This setting can only be changed when the Community is being created. If it is set to false and it used to be true, then the Community will copy the current settings of the Community template and it will not inherit future changes to the Community template. Setting it to false, when it was already false will have no affect. It cannot be set to true, once it has been set to false.

Parameters:

bInheritCommunityTemplate -