com.plumtree.server
Interface IPTMyPages

All Superinterfaces:
IPTLocalizable, IPTObject, IPTPageContainer, IPTPreferencesContext, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTMyPages
extends IPTPageContainer

IPTMyPages

Author:
Self-Service Communities, Michael DeCourcey

Method Summary
 int AddPage(java.lang.String strPageName, int nPageType)
          Deprecated.  
 void FlushCaches()
          Deprecated. Method FlushCaches is deprecated. Use IPTMyPages.FlushMandatoryGadgetsCache() and IPTCommunityManager.FlushMandatoryTabsCache() instead.
 void FlushMandatoryGadgetsCache()
          Flush the mandatory gadget cache.
 void JoinCommunity(int nCommunityID, int nMembershipType)
          Deprecated. Method JoinCommunity is deprecated. Use IPTCommunityManager.JoinCommunity(int, int) instead.
 IPTMyPortal OpenPage(int nPageID)
          Deprecated. Method OpenPage is deprecated. Use IPTPageContainer.GetPage instead. IPTMyPages extends IPTPageContainer.
 IPTQueryResult QueryAvailableCommunities()
          Deprecated. Method QueryAvailableCommunities is deprecated. Use IPTCommunityManager.QueryAvailableCommunities() instead.
 IPTQueryResult QueryMandatoryGadgets()
          Query for the current user's mandatory gadgets.
 IPTQueryResult QueryMandatoryTabs()
          Deprecated. Method QueryMandatoryTabs is deprecated. Use IPTCommunityManager.QueryMandatoryTabs() instead.
 IPTQueryResult QueryMemberships()
          Deprecated. Method QueryMemberships is deprecated. Use IPTCommunityManager.QueryMemberships() instead.
 void QuitCommunity(int nCommunityID)
          Deprecated. Method QuitCommunity is deprecated. Use IPTCommunityManager.QuitCommunity(int) instead.
 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 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
 
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)
Deprecated. 

Add a page to the page container.

Parameters:
strPageName - - new page name
nPageType - - new page type
Returns:
int - newly created page id

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. IPTMyPages extends IPTPageContainer.

Open the IPTMyPortal object for a particular page.

Parameters:
nPageID - - page if of the desired page
Returns:
IPTMyPortal - object that encapsulates page data

QueryMemberships

IPTQueryResult QueryMemberships()
Deprecated. Method QueryMemberships is deprecated. Use IPTCommunityManager.QueryMemberships() instead.

Query for the current user's community memberships, which includes communities that the user has joined and communities that are mandatory for groups that the user is in.

Returns:
IPTQueryResult - query result with the following PROPIDS: PT_PROPID_NAME PT_PROPID_OBJECTID PT_PROPID_MEMBERSHIP_TYPE

QueryAvailableCommunities

IPTQueryResult QueryAvailableCommunities()
Deprecated. Method QueryAvailableCommunities is deprecated. Use IPTCommunityManager.QueryAvailableCommunities() instead.

Query for communities that are available to the current user.

Returns:
IPTQueryResult - query result with the following PROPIDS: PT_PROPID_NAME PT_PROPID_ISLOCALIZED PT_PROPID_OBJECTID

JoinCommunity

void JoinCommunity(int nCommunityID,
                   int nMembershipType)
Deprecated. Method JoinCommunity is deprecated. Use IPTCommunityManager.JoinCommunity(int, int) instead.

Join the current user to a community with a particular membership type.

Parameters:
nCommunityID - - community id to join
nMembershipType - - of type PT_COMMUNITY_MEMBERSHIPTYPE

QuitCommunity

void QuitCommunity(int nCommunityID)
Deprecated. Method QuitCommunity is deprecated. Use IPTCommunityManager.QuitCommunity(int) instead.

Remove the current user from a community that they are currently joined to.

Parameters:
nCommunityID - - community id to quit

QueryMandatoryTabs

IPTQueryResult QueryMandatoryTabs()
Deprecated. Method QueryMandatoryTabs is deprecated. Use IPTCommunityManager.QueryMandatoryTabs() instead.

Query for current user's list of mandatory communities that appear with navigation tabs.

Returns:
IPTQueryResult - query result with the following PROPIDS: PT_PROPID_OBJECTID PT_PROPID_NAME PT_PROPID_ISLOCALIZED

ResetPageName

void ResetPageName(int nPageID,
                   java.lang.String strPageName)
Deprecated. Method ResetPageName is deprecated. Use IPTPage.SetName instead.

Change the page name of a particular my page that belongs to the current user.

Parameters:
nPageID - - page id to change the name of
strPageName - - new page name

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.

Change the page type (layout) of a particular my page that belongs to the current user.

Parameters:
nPageID - - page id to change the type of
nPageType - - new page type (constants for this are defined in the UI)

QueryMandatoryGadgets

IPTQueryResult QueryMandatoryGadgets()
Query for the current user's mandatory gadgets.

Returns:
IPTQueryResult - query result with the following PROPIDS: PT_PROPID_OBJECTID PT_PROPID_MYPORTAL_TOPICPOS PT_PROPID_GADGET_COLUMN PT_PROPID_LASTMODIFIED PT_PROPID_NAME PT_PROPID_ISLOCALIZED PT_PROPID_GADGET_ALIGNMENT PT_PROPID_GADGET_GADGETTYPE PT_PROPID_WEBSERVICE_PERSONALIZATION

FlushCaches

void FlushCaches()
Deprecated. Method FlushCaches is deprecated. Use IPTMyPages.FlushMandatoryGadgetsCache() and IPTCommunityManager.FlushMandatoryTabsCache() instead.

Flush the mandatory gadget and mandatory tabs caches. Calling this function frequently will result in performance problems.


FlushMandatoryGadgetsCache

void FlushMandatoryGadgetsCache()
Flush the mandatory gadget cache. Calling this function frequently will result in performance problems.



Copyright 2008 Plumtree Software Inc. All Rights Reserved.