|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
IPTPageInfo |
GetPage(int nPageID)
Gets the cached IPTPageInfo object for the specified page |
IPTQueryResult |
GetPages()
Gets specific or all pages inside this community from the cache. |
IPTQueryResult |
GetParentCommunity()
Gets the parent community of this community from the cache. |
IPTQueryResult |
GetPeerCommunities()
Gets this Community's peer communities, i.e. |
java.lang.String |
GetPrimaryName()
Gets the primary name of this Community |
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. |
java.lang.Object[][] |
LookupPreference(java.lang.String _strPreferenceName,
int _nPortletID,
PT_PREF_TYPES _prefType)
This method looks up a preference. |
java.lang.Object[][] |
LookupPreferences(java.lang.String[] _astrPreferenceNames,
int _nPortletID,
PT_PREF_TYPES _prefType)
This method looks up preferences. |
IPTMyPortal |
OpenPage(int nPageID)
Deprecated. Method OpenPage is deprecated. Use GetPage instead, which returns the cached version of the Page, IPTPageInfo. |
IPTMyPortalGadgetContent |
QueryHeaderAndFooter(java.lang.Object appDateStateObj,
java.lang.String strUserInterfaceID,
int nGadgetMode,
boolean bReturnAllGadgets)
Deprecated. Use IPTPageInfo.QueryPortletContent instead. If you are not on a Community Page or My Page, then use the IPTPageInfo for the Global Page: PT_INTRINSICS.PT_PAGE_GLOBAL. |
IPTQueryResult |
QueryPages()
Deprecated. Use GetPages instead. QueryPages uses more memory than than GetPages. |
IPTQueryResult |
QueryPrefs()
Gets Community preference and Community gadget preferences from the cache. |
Method Detail |
---|
IPTQueryResult QueryPages()
IPTQueryResult GetPages()
IPTQueryResult QueryPrefs()
PT_PROPIDS
IPTMyPortal OpenPage(int nPageID)
nPageID
- ID of Page to open
java.lang.Exception
- with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS errorcode if the user has insufficient
access to the communityIPTPageInfo GetPage(int nPageID)
nPageID
- ID of Page to get from the cache
java.lang.Exception
- with PT_RESULTCODES.PT_E_INSUFFICIENTROLEACCESS errorcode if the user has insufficient
access to the community, or the pageIPTQueryResult GetParentCommunity()
IPTQueryResult GetPeerCommunities()
IPTQueryResult GetSubcommunities()
java.lang.String GetName()
int GetObjectID()
int GetHeaderID()
int GetFooterID()
int GetAccessLevel()
PT_ACCESS_LEVELS
boolean GetSiteMapDisabled()
java.lang.String GetStyleSheet()
int GetSiteMapRootID()
IPTMyPortalGadgetContent QueryHeaderAndFooter(java.lang.Object appDateStateObj, java.lang.String strUserInterfaceID, int nGadgetMode, boolean bReturnAllGadgets)
appDateStateObj
- strUserInterfaceID
- nGadgetMode
- bReturnAllGadgets
-
java.lang.Object[][] LookupPreference(java.lang.String _strPreferenceName, int _nPortletID, PT_PREF_TYPES _prefType)
_strPreferenceName
- is the name of the preference to look up._nPortletID
- is the Portlet the preference is set on. Use 0 if the preference
is not a portlet preference._prefType
- is the type of the preference. Use PT_PREF_TYPE.PT_PREFTYPE_CURRENT_USER if the
preference is a preference for just this user. Use PT_PREF_TYPE.PT_PREFTYPE_ALL_USERS
if the preference is a preference for all users.
java.lang.Object[][] LookupPreferences(java.lang.String[] _astrPreferenceNames, int _nPortletID, PT_PREF_TYPES _prefType)
_astrPreferenceNames
- is an array of the names of preferences to look up._nPortletID
- is the Portlet the preference is set on. Use 0 if the preference
is not a portlet preference._prefType
- is the type of the preference. Use PT_PREF_TYPE.PT_PREFTYPE_CURRENT_USER if the
preference is a preference for just this user. Use PT_PREF_TYPE.PT_PREFTYPE_ALL_USERS
if the preference is a preference for all users.
java.lang.String GetPrimaryName()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |