com.plumtree.server
Interface IPTCommunityInfo


public interface IPTCommunityInfo


Method Summary
 int GetAccessLevel()
          Get the ACL to this Community for the current user.
 int GetFooterID()
          Get the footer ID assigned to this community from the cache.
 int GetHeaderID()
          Get the header ID assigned to this community from the cache.
 java.lang.String GetName()
          Gets the name of this Community
 int GetObjectID()
          Gets the Object ID of this Community
 IPTQueryResult GetParentCommunity()
          Gets the parent community of this community from the cache.
 IPTQueryResult GetPeerCommunities()
          Gets this Community's peer communities, i.e.
 boolean GetSiteMapDisabled()
          Checks if the community sitemap is disabled for this community from the cache.
 int GetSiteMapRootID()
          Gets the ID root sitemap folder for this community from the cache.
 java.lang.String GetStyleSheet()
          Gets the Stylesheet, stored as an administrative portlet preference on the header portlet assigned to this SubPortal (if any).
 IPTQueryResult GetSubcommunities()
          Gets this Community's subcommunities, i.e.
 IPTMyPortal OpenPage(int nPageID)
          Gets the PTMyPortal object for the specified page
 IPTMyPortalGadgetContent QueryHeaderAndFooter(java.lang.Object appDateStateObj, java.lang.String strUserInterfaceID, int nGadgetMode, boolean bReturnAllGadgets)
           
 IPTQueryResult QueryPages()
          Gets specific or all pages inside this community from the cahce.
 IPTQueryResult QueryPrefs()
          Gets Community preference and Community gadget preferences from the cache.
 

Method Detail

QueryPages

public IPTQueryResult QueryPages()
Gets specific or all pages inside this community from the cahce.
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).

QueryPrefs

public IPTQueryResult QueryPrefs()
Gets Community preference and Community gadget preferences from the cache.
Returns:
IPTQueryResult QueryResult with preferences containing the PT_PROPID_PREFS_GADGETID, PT_PROPID_PREFS_PREFNAME, PT_PROPID_PREFS_PREFVALUETYPE, PT_PROPID_PREFS_PREFVALUE and PT_PROPID_PREFS_PAGENUMBER columns.
See Also:
PT_PROPIDS

OpenPage

public IPTMyPortal OpenPage(int nPageID)
Gets the PTMyPortal object for the specified page
Parameters:
nPageID - ID of Page to open
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

GetParentCommunity

public IPTQueryResult GetParentCommunity()
Gets the parent community of this community from the cache.
Returns:
IPTQueryResult

GetPeerCommunities

public IPTQueryResult GetPeerCommunities()
Gets this Community's peer communities, i.e. other communities in the same level of the admin folder hierarchy, from the cache.
Returns:
IPTQueryResult

GetSubcommunities

public IPTQueryResult GetSubcommunities()
Gets this Community's subcommunities, i.e. other communities in this community's folder, from the cache.
Returns:
IPTQueryResult

GetName

public java.lang.String GetName()
Gets the name of this Community
Returns:
String Name of current Community

GetObjectID

public int GetObjectID()
Gets the Object ID of this Community
Returns:
Object ID of this Community

GetHeaderID

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

GetFooterID

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

GetAccessLevel

public int GetAccessLevel()
Get the ACL to this Community for the current user.
Returns:
An ACL defined in PT_ACCESS_LEVELS
See Also:
PT_ACCESS_LEVELS

GetSiteMapDisabled

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

GetStyleSheet

public java.lang.String GetStyleSheet()
Gets the Stylesheet, stored as an administrative portlet preference on the header portlet assigned to this SubPortal (if any).
Returns:
String Stylesheet file name

GetSiteMapRootID

public int GetSiteMapRootID()
Gets the ID root sitemap folder for this community from the cache.
Returns:
ID of Root sitemap folder object

QueryHeaderAndFooter

public IPTMyPortalGadgetContent QueryHeaderAndFooter(java.lang.Object appDateStateObj,
                                                     java.lang.String strUserInterfaceID,
                                                     int nGadgetMode,
                                                     boolean bReturnAllGadgets)
Parameters:
appDateStateObj -  
strUserInterfaceID -  
nGadgetMode -  
bReturnAllGadgets -  
Returns:
IPTMyPortalGadgetContent


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.