com.plumtree.server
Interface IPTMyPages

All Superinterfaces:
IPTUnknown

public interface IPTMyPages
extends IPTUnknown

IPTMyPages


Method Summary
 int AddPage(java.lang.String strPageName, int nPageType)
          Add a new my page for the current user.
 void FlushCaches()
          Flush the mandatory gadget and mandatory community caches.
 void JoinCommunity(int nCommunityID, int nMembershipType)
          Join the current user to a community with a particular membership type.
 IPTMyPortal OpenPage(int nPageID)
          Open the IPTMyPortal object for a particular page.
 IPTQueryResult QueryAvailableCommunities()
          Query for communities that are available to the current user.
 IPTQueryResult QueryMandatoryGadgets()
          Query for the current user's mandatory gadgets.
 IPTQueryResult QueryMandatoryTabs()
          Query for current user's list of mandatory communities that appear with navigation tabs.
 IPTQueryResult QueryMemberships()
          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.
 IPTQueryResult QueryPages(int nPageID)
          Query for current user's my pages
 void QuitCommunity(int nCommunityID)
          Remove the current user from a community that they are currently joined to.
 void RemovePage(int nPageID)
          Remove a particular page from the current user's set of my pages.
 void ResetPageName(int nPageID, java.lang.String strPageName)
          Change the page name of a particular my page that belongs to the current user.
 void ResetPageType(int nPageID, int nPageType)
          Change the page type (layout) of a particular my page that belongs to the current user.
 void ResetPageURL(int nPageID, java.lang.String strURL)
          Deprecated. - This method should not be called The URL column in PTMyPages and PTCommPages should be removed as well.
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

QueryPages

public IPTQueryResult QueryPages(int nPageID)
Query for current user's my pages
Parameters:
nPageID - - page id to get. If this value is 0, the function will return all pages.
Returns:
IPTQueryResult - query result with the following PROPIDS: PT_PROPID_NAME PT_PROPID_PAGEID PT_PROPID_TYPE

AddPage

public int AddPage(java.lang.String strPageName,
                   int nPageType)
Add a new my page for the current user.
Parameters:
strPageName - - new page name
nPageType - - new page type
Returns:
int - newly created page id

RemovePage

public void RemovePage(int nPageID)
Remove a particular page from the current user's set of my pages.
Parameters:
nPageID - - page id of the page to be removed

OpenPage

public IPTMyPortal OpenPage(int nPageID)
Open the IPTMyPortal object for a particular page.
Parameters:
nPageID - - page if of the desired page
Returns:
IPTMyPortal - object that encapsulates page data

QueryMemberships

public IPTQueryResult QueryMemberships()
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

public IPTQueryResult QueryAvailableCommunities()
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

public void JoinCommunity(int nCommunityID,
                          int nMembershipType)
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

public void QuitCommunity(int nCommunityID)
Remove the current user from a community that they are currently joined to.
Parameters:
nCommunityID - - community id to quit

QueryMandatoryTabs

public IPTQueryResult QueryMandatoryTabs()
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

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

public void ResetPageURL(int nPageID,
                         java.lang.String strURL)
Deprecated. - This method should not be called The URL column in PTMyPages and PTCommPages should be removed as well.

Reset the page URL for a particular my page owned by the current user. This function is useless because trying to get the URL from the my page will throw an exception, whereas trying to get the URL from a community page will return the page type.
Parameters:
nPageID - - page id to update
strURL - - new URL

ResetPageType

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

public 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

public void FlushCaches()
Flush the mandatory gadget and mandatory community caches. Calling this function frequently will result in performance problems.


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.