com.plumtree.server
Interface IPTCommunity

All Superinterfaces:
IPTLocalizable, IPTObject, IPTUnknown

public interface IPTCommunity
extends IPTObject


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)
           
 void AssignPages(int nPageID)
          Assigns new page order.
 void AssignPages(int[] arPageIDs)
          Assigns new page order.
 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.
 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)
          Gets the PTMyPortal object for the specified page
 IPTQueryResult QueryMembers(int nMemberType)
          Get either the users or groups who are members of this community.
 IPTQueryResult QueryPages(int nPageID)
          Queries for specific or all pages inside 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)
          Removes a page from this community.
 void ResetPageName(int nPageID, java.lang.String strPageName)
          Renames a page, maximum page length is defined by PT_SERVERCONSTANTS.PT_MAX_PAGENAMELENGTH Requires EDIT access on the community.
 void ResetPagePageTemplateID(int nPageID, int nPageTemplateID)
          Set a new pagetemplate for specified page.
 void ResetPageType(int nPageID, int nPageType)
          Assigns a new pagetype for the specified page.
 void ResetPageURL(int nPageID, java.lang.String strURL)
          Assigns new page url to the specified page.
 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 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.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
 

Method Detail

QueryPages

public IPTQueryResult QueryPages(int nPageID)
Queries for specific or all pages inside this community.
Parameters:
nPageID - ID of a specific page or 0 for all pages
Returns:
QueryResult of the pages in this community with standard properties plus PT_PROPIDS.PT_PROPID_PAGES_PAGEID, PT_PROPIDS.PT_PROPID_PAGES_URL, PT_PROPIDS.PT_PROPID_PAGES_TYPE, PT_PROPIDS.PT_PROPID_PAGES_PAGETEMPLATEID, PT_PROPIDS.PT_PROPID_PAGES_FROMCOMMTEMP, PT_PROPIDS.PT_PROPID_PAGES_TOPICPOS Querying for all pages returns them in their assigned order (by TOPICPOS).

AddPage

public int AddPage(java.lang.String strPageName,
                   int nPageType,
                   int nPageTemplateID,
                   int nFromCommunityTemplate)
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

public void RemovePage(int nPageID)
Removes a page from this community. The community home page or any pages defined in the current assigned community template cannot be removed. Removing a page requires at least EDIT access to the communuty.
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

public IPTMyPortal OpenPage(int nPageID)
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

public 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

public 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

public 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

public 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

public java.lang.String GetOwnerInfo()
Get the owner info for this community.
Returns:
Ownerinfo

SetOwnerInfo

public void SetOwnerInfo(java.lang.String strOwnerInfo)
Assigns new owner info for this community.
Parameters:
strOwnerInfo - New owner info

GetMandatoryTabOrder

public int GetMandatoryTabOrder()
Get the mandatory community tab priority assigned for this community.
Returns:
Mandatory Community tab priority

SetMandatoryTabOrder

public 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

public void ResetPageName(int nPageID,
                          java.lang.String strPageName)
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

public void ResetPageURL(int nPageID,
                         java.lang.String strURL)
Assigns new page url to the specified page. Maximum url length defined by PT_SERVERCONSTANTS.PT_MAX_URLLENGTH. Requires EDIT access to the community.
Parameters:
nPageID - ID of page to assign new URL for
strURL - New page URL, cannot exceed PT_SERVERCONSTANTS#PT_MAX_URLLENGTH
See Also:
PT_SERVERCONSTANTS.PT_MAX_URLLENGTH

ResetPageType

public void ResetPageType(int nPageID,
                          int nPageType)
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

public IPTSiteMapFolder GetSiteMapRoot()
Get the root sitemap folder for this community
Returns:
Root sitemap folder object

ResetPagePageTemplateID

public void ResetPagePageTemplateID(int nPageID,
                                    int nPageTemplateID)
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

public int GetCommunityTemplateID()
Get the community template ID assigned to this community.
Returns:
Community template ID assigned to this community

SetCommunityTemplateID

public 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

public int GetHeaderID()
Gets the header ID assigned to this community.
Returns:
Header ID assigned to this community

SetHeaderID

public 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

public int GetFooterID()
Gets the footer ID assigned to this community.
Returns:
Footer ID assigned to this community

SetFooterID

public 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

public boolean GetSiteMapDisabled()
Checks if the community sitemap is disabled for this community.
Returns:
true if sitemap is disabled, false otherwise

SetSiteMapDisabled

public void SetSiteMapDisabled(boolean bValue)
Sets flag to disable sitemap.
Parameters:
True - to disable sitemap in this community, false to enable

AssignPages

public void AssignPages(int[] arPageIDs)
Assigns new page order.
Parameters:
arPageIDs - Integer (int) array of Page IDs with new order page order. Page IDs in the array must be unique.

AssignPages

public void AssignPages(int nPageID)
Assigns new page order.
Parameters:
nPageID - Single Page ID with new order page order.


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.