com.plumtree.server
Interface IPTPageContainer

All Superinterfaces:
IPTLocalizable, IPTObject, IPTPreferencesContext, IPTServerContext, IPTStorable, IPTUnknown
All Known Subinterfaces:
IPTCommunity, IPTMyPages

public interface IPTPageContainer
extends IPTPreferencesContext

Author:
Michael DeCourcey

Method Summary
 void AssignPages(int nPageID)
          Assigns new page order.
 void AssignPages(int[] arPageIDs)
          Assigns new page order.
 IPTPageInfo GetPage(int nPageID)
          Gets the cached version of the specified page
 IPTQueryResult QueryPages(int nPageID)
          Query for specific or all pages inside this page container.
 
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

QueryPages

IPTQueryResult QueryPages(int nPageID)
Query for specific or all pages inside this page container.

Parameters:
nPageID - - If value is greater than 0, then return a query result from of the page with that ID. If value is 0, then return a query result of all the pages in this page container.
Returns:
QueryResult of the pages in this page container with standard properties plus PT_PROPIDS.PT_PROPID_PAGES_PAGEID, PT_PROPIDS.PT_PROPID_PAGES_TYPE, PT_PROPIDS.PT_PROPID_PAGES_PAGETEMPLATEID, PT_PROPIDS.PT_PROPID_PAGES_NOTDELETABLE, PT_PROPIDS.PT_PROPID_PAGES_TOPICPOS Querying for all pages returns them in their assigned order (by TOPICPOS).

AssignPages

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

void AssignPages(int nPageID)
Assigns new page order.

Parameters:
nPageID - Single Page ID with new order page order.

GetPage

IPTPageInfo GetPage(int nPageID)
Gets the cached version of the specified page

Parameters:
nPageID - Page ID or 0 for the first page in the container.
Returns:
IPTPageInfo for the specfied page
Throws:
java.lang.Exception - with PT_RESULTCODES.PT_E_COMMUNITY_NO_ACL_ON_ALL_PAGES or PT_RESULTCODES.PT_E_COMMUNITY_NO_ACL_ON_PAGE errorcode if the user has insufficient access to the page container or page.


Copyright 2008 Plumtree Software Inc. All Rights Reserved.