|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
| 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 |
public IPTQueryResult QueryPages(int nPageID)
nPageID - ID of a specific page or 0 for all pages
public int AddPage(java.lang.String strPageName,
int nPageType,
int nPageTemplateID,
int nFromCommunityTemplate)
strPageName - Name of pagenPageType - One of the constants defined in PT_PAGE_TYPES, right now only PT_PAGETYPE_REGULARnPageTemplateID - PageTemplateIDnFromCommunityTemplate - 1 if the pagetemplate is in a communitytemplate, 0 or less otherwisePT_PAGE_TYPESpublic void RemovePage(int nPageID)
nPageID - ID of the page to removejava.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS errorcode if the user has insufficient
access to the communitypublic IPTMyPortal OpenPage(int nPageID)
nPageID - Page IDjava.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS errorcode if the user has insufficient
access to the communitypublic IPTQueryResult QueryMembers(int nMemberType)
nMemberType - Either PT_CLASSIDS.PT_USER_ID or PT_CLASSIDS.PT_USERGROUP_IDPT_CLASSIDSpublic IPTQueryResult QuerySubcommunities()
public void AddMandatoryGroupMember(int nGroupID,
int nMemberType)
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.PT_COMMUNITY_MEMBERSHIPTYPEpublic void RemoveMandatoryGroupMember(int nGroupID)
nGroupID - ID of the group to remove, users (negative IDs) are not accepted.java.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS errorcode if the user has insufficient
access to the communitypublic java.lang.String GetOwnerInfo()
public void SetOwnerInfo(java.lang.String strOwnerInfo)
strOwnerInfo - New owner infopublic int GetMandatoryTabOrder()
public void SetMandatoryTabOrder(int nMandatoryTabOrder)
nMandatoryTabOrder - One of the mandatory community tab priority defined in PT_MANDATORYORDERINGPT_MANDATORYORDERING
public void ResetPageName(int nPageID,
java.lang.String strPageName)
nPageID - ID of the page to renamestrPageName - New page namejava.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS errorcode if the user has insufficient
access to the communityPT_SERVERCONSTANTS.PT_MAX_PAGENAMELENGTH
public void ResetPageURL(int nPageID,
java.lang.String strURL)
nPageID - ID of page to assign new URL forstrURL - New page URL, cannot exceed PT_SERVERCONSTANTS#PT_MAX_URLLENGTHPT_SERVERCONSTANTS.PT_MAX_URLLENGTH
public void ResetPageType(int nPageID,
int nPageType)
nPageID - ID of page to assign new pagetype tonPageType - New pagetype for the specified pagepublic IPTSiteMapFolder GetSiteMapRoot()
public void ResetPagePageTemplateID(int nPageID,
int nPageTemplateID)
nPageID - ID of Page to assign new pagetemplate tonPageTemplateID - ID of new pagetemplate for the specified pagejava.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS if the user has insufficient
access to the communitypublic int GetCommunityTemplateID()
public void SetCommunityTemplateID(int nCommunityTemplateID)
nCommunityTemplateID - ID of the new community templatejava.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS errorcode if the user has insufficient
access to the communitypublic int GetHeaderID()
public void SetHeaderID(int nHeaderID)
nHeaderID - ID of a header gadgetjava.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS errorcode if the user has insufficient
access to the communitypublic int GetFooterID()
public void SetFooterID(int nFooterID)
nFooterID - ID of a footer gadgetjava.lang.Exception - with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS errorcode if the user has insufficient
access to the communitypublic boolean GetSiteMapDisabled()
public void SetSiteMapDisabled(boolean bValue)
True - to disable sitemap in this community, false to enablepublic void AssignPages(int[] arPageIDs)
arPageIDs - Integer (int) array of Page IDs with new order page order. Page IDs in the array must be unique.public void AssignPages(int nPageID)
nPageID - Single Page ID with new order page order.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||