|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ITaskAPIUICommunity
This interface describes the various helper methods for Communities in the Task API.
Method Summary | |
---|---|
boolean |
CheckUserAccessLevelToCommunity(AActivitySpace owner,
int nAccessLevel,
int nCommunityID)
Check the if the current user has at least the accesslevel specified to the current community |
boolean |
CheckUserAccessLevelToCurrentCommunity(AActivitySpace owner,
int nAccessLevel)
Check the if the current user has at least the accesslevel specified to the current community |
boolean |
CheckUserAccessLevelToCurrentCommunityPage(AActivitySpace owner,
int nAccessLevel)
Check the if the current user has at least the accesslevel specified to the current community page |
IPTURL |
CreateCommunityCommonOpenerURL(AActivitySpace owner,
int nCommunityID,
java.lang.String strCommunityName)
Helper function to create an URL to a specified Community. |
IPTURL |
CreateCommunityPageCommonOpenerURL(AActivitySpace owner,
int nCommunityID,
int nCommunityPageID,
java.lang.String strCommunityPageName)
Helper function to create an URL to a specified Community Page. |
IPTURL |
CreateUserProfilePageCommonOpenerURL(AActivitySpace owner,
int nProfileUserID,
java.lang.String sProfileUserName)
Gets an URL to a UserProfile page for the specified user. |
IPTURL |
CreateUserProfilePageCommonOpenerURL(AActivitySpace owner,
int nProfileUserID,
java.lang.String sProfileUserName,
java.lang.String strURLTitle)
Gets an URL to a UserProfile page for the specified user. |
IPTURL |
CreateUserProfilePageCommonOpenerURL(AActivitySpace owner,
int nProfileUserID,
java.lang.String sProfileUserName,
java.lang.String strURLTitle,
int nPageId,
java.lang.String strPageName)
Gets an URL to a UserProfile page for the specified user. |
XPArrayList |
GetCommunityActionsAsURLs(AActivitySpace owner)
Gets Community Actions as an XPArrayList with IPTURL entries. |
XPArrayList |
GetCommunityActionsAsURLs(AActivitySpace owner,
boolean bIncludeOneClick,
boolean bInheritTemplate,
int nPageTemplate)
Gets Community Actions as an XPArrayList with IPTURL entries. |
int |
GetCommunityIDFromPTURL(IPTURL ptURL)
Gets the Community ID from an IPTURL with an URL to a Community or Community Page. |
java.lang.String |
GetCommunityName(AActivitySpace owner,
int nCommunityID)
Gets the name of the specified Community. |
int |
GetCommunityPageIDFromPTURL(IPTURL ptURL)
Gets the Community Page ID from an IPTURL with an URL to a Community Page. |
XPArrayList |
GetCommunityPagesAsURLs(AActivitySpace owner,
int nCommunityID)
Get Community Pages in the specified Community as a list of IPTURL s. |
int |
GetCurrentCommunityID(AActivitySpace owner)
Gets the Community ID of the current Community. |
java.lang.String |
GetCurrentCommunityName(AActivitySpace owner)
Gets the Community Name of the current Community. |
int |
GetCurrentCommunityPageID(AActivitySpace owner)
Gets the current Community Page ID, If current page is not a Community page, the TaskAPIUICommon.INVALID_OBJECTID value is returned. |
java.lang.String |
GetCurrentCommunityPageName(AActivitySpace owner)
Gets the Community Page Name of the current Community Page. |
XPArrayList |
GetCurrentCommunityPagesAsURLs(AActivitySpace owner)
Gets the Community Pages of the current Community as an XPArraylist with IPTURL entries. |
IPTURL |
GetCurrentPageAsURL(AActivitySpace owner)
Gets the current Page as an object of type IPTURL . |
IPTURL |
GetCurrentParentCommunityAsURL(AActivitySpace owner)
Gets the URL to the parent Community of the current Community. |
int |
GetCurrentParentCommunityID(AActivitySpace owner)
Gets the Object ID of the parent Community in the current Community. |
XPArrayList |
GetCurrentRelatedCommunitiesAsURLs(AActivitySpace owner)
Gets URLs to Related Communities for for the current Community in a list of IPTURL s. |
int[] |
GetCurrentRelatedCommununityIDs(AActivitySpace owner)
Gets Related Communities (a.k.a. |
XPArrayList |
GetCurrentSubCommunitiesAsURLs(AActivitySpace owner)
Gets Subcommunities in the current Community as an XPArrayList with IPTURL entries. |
int[] |
GetCurrentSubCommunityIDs(AActivitySpace owner)
Gets the Subcommunities of the current Community as a integer array. |
int |
GetDefaultCommunityID(AActivitySpace owner)
Gets the default Community ID, the first Community in a user's My Community list. |
XPArrayList |
GetMyCommunitiesAsURLs(AActivitySpace owner,
boolean bUseCachedData)
Gets a user's My Communities list as an XPArrayList with IPTURL entries. |
XPArrayList |
GetMyMandatoryCommunitiesWithTabsAsURLs(AActivitySpace owner,
boolean bUseCachedData)
Gets a user's Mandatory with Tab Communities as an XPArrayList with IPTURL entries. |
IPTURL |
GetParentCommunityAsURL(AActivitySpace owner,
int nCommunityID)
Gets the URL to the parent Community of the specified Community. |
int |
GetParentCommunityID(AActivitySpace owner,
int nCommunityID)
Gets the Object ID of the parent Community in the specified Community. |
XPArrayList |
GetRelatedCommununitiesAsURLs(AActivitySpace owner,
int nCommunityID)
Gets URLs to Related Communities for the specified Community in a list of IPTURL s. |
int[] |
GetRelatedCommununityIDs(AActivitySpace owner,
int nCommunityID)
Gets the Related Communities for the specified Community as an integer array. |
XPArrayList |
GetSubCommununitiesAsURLs(AActivitySpace owner,
int nCommunityID)
Gets the Subcommunities for the specified Community as a list with IPTURL entries. |
int[] |
GetSubCommununityIDs(AActivitySpace owner,
int nCommunityID)
Gets the Subcommunities for the specified Community as an integer array. |
IPTURL |
GetURLForAddCommunityPortletsEditor(AActivitySpace owner)
Gets the URL to the Community Add Portlets Editor. |
IPTURL |
GetURLForAddCommunityPortletsFlyout(AActivitySpace owner)
Gets the URL to the Community Add Portlets Flyout. |
IPTURL |
GetURLForCommunityKnowledgeDirectory(AActivitySpace owner,
int nCommunityID)
Gets to URL to the Community Knowledge Directory f0r the current Community. |
IPTURL |
GetURLForCreateCommunityPage(AActivitySpace owner)
Gets the URL to the Create Community page in the Community Editor. |
IPTURL |
GetURLForCreateCommunityPageOneClick(AActivitySpace owner,
boolean bInheritTemplate,
int nPageTemplate)
Gets the URL to the Create Community page in the Community Editor. |
XPArrayList |
GetURLForCurrentCommunity(AActivitySpace owner)
Gets an XPArrayList with a single entry for the URL for the current Community. |
IPTURL |
GetURLForCurrentCommunityEditor(AActivitySpace owner)
Gets the URL to the Community Editor for the current Community. |
IPTURL |
GetURLForEditPortletPreferencesEditor(AActivitySpace owner)
Gets the URL to the Community Edit Portlet Preferences Editor. |
IPTURL |
GetURLForJoinCommunitiesEditor(AActivitySpace owner)
Gets the URL for the Join Community Editor where users add Communities to their My Communities list. |
IPTURL |
GetURLForJoinCurrentCommunityAction(AActivitySpace owner)
Gets the URL to Join Current Community Action. |
IPTURL |
GetURLForUnsubscribeCommunitiesEditor(AActivitySpace owner)
Gets the URL to the Unsubscribe from Communities Editor. |
IPTURL |
GetURLForUnsubscribeCurrentCommunityAction(AActivitySpace owner)
Gets the URL to Unsubscribe Current Community Action. |
boolean |
IsCommunityMember(AActivitySpace _asOwner,
int _nCommunityID)
Checks whether or not the current user is a member of the specified community. |
boolean |
IsCurrentCommunityUserProfileCommunity(AActivitySpace owner)
Checks if the current Community is the User Profile Community. |
boolean |
IsCurrentPageCommunityPage(AActivitySpace owner)
Checks if the current page is a Community Page. |
boolean |
IsCurrentPageMyPortalPage(AActivitySpace owner)
Checks if the current page is a Myportal page, i.e. |
boolean |
IsCurrentUserAbleToEditCurrentCommunityPage(AActivitySpace owner)
Checks if the current user has access (requires EDIT access) to use the Community Editor on the current Community Page. |
boolean |
IsCurrentUserCommunityOwner(AActivitySpace owner)
Checks if the current user is the owner of the current Community. |
boolean |
IsUserAbleToAccessCurrentCommunity(AActivitySpace owner)
Checks if the current user has at least READ access to the current Community. |
boolean |
IsUserAbleToJoinCurrentCommunity(AActivitySpace owner)
Checks if the current user has at least SELECT access to the current Community. |
boolean |
IsUserMemberOfCurrentCommunity(AActivitySpace owner)
Checks if the current user is already subscribed to the current Community, i.e. |
boolean |
JoinCommunity(AActivitySpace _asOwner,
int _nCommunityID)
This method causes the current user to join the specified community. |
boolean |
LeaveCommunity(AActivitySpace _asOwner,
int _nCommunityID)
This method causes the current user to leave the specified community. |
Method Detail |
---|
java.lang.String GetCommunityName(AActivitySpace owner, int nCommunityID)
owner
- Current Activityspace.nCommunityID
- Object ID of the Community to retrieve the name for.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.int[] GetSubCommununityIDs(AActivitySpace owner, int nCommunityID)
owner
- Current Activityspace.nCommunityID
- Object ID for the Community to retrieve Subcommunities from.
XPException
- If the Community could not be accessed, for example if the Object ID
is not valid.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.int[] GetRelatedCommununityIDs(AActivitySpace owner, int nCommunityID)
owner
- Current Activityspace.nCommunityID
- Object ID for the Community to retrieve Related Communities from.
XPException
- If the Community could not be accessed, for example if the Object ID
is not valid.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.XPArrayList GetCommunityPagesAsURLs(AActivitySpace owner, int nCommunityID)
IPTURL
s.
The PTURLConstants.KEY_CURRENTMARKER
flag is set on an URL entry if is leading to the current
Community Page.
owner
- Current Activityspace.nCommunityID
- Object Id of the Community to list pages of.
IPTURL
objects or an empty list of no pages exist.
XPIllegalArgumentException
- If the user does not have sufficient access to the Community.IPTURL GetURLForCommunityKnowledgeDirectory(AActivitySpace owner, int nCommunityID)
PTURLConstants.KEY_CURRENTMARKER
flag is set on the URL if the current page is a Community Knowledge
Directory page.
owner
- Current ActivityspacenCommunityID
- Object ID of the Community to get pages from.
IPTURL
with the URL to the Community Knowledge Directory for the specified Community.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.PTURLConstants
XPArrayList GetRelatedCommununitiesAsURLs(AActivitySpace owner, int nCommunityID)
IPTURL
s.
Related Communities are Communities in the same administrative folder.
owner
- Current Activityspace.nCommunityID
- Object ID for the Community to retrieve Related Communities from.
XPArrayList
with IPTURL
s to Related Communities or an empty XPArrayList
if none exists.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.java.lang.String GetCurrentCommunityName(AActivitySpace owner) throws XPIllegalArgumentException
owner
- Current Activityspace.
null
value if not currently on a Community Page.
XPIllegalArgumentException
- If the provided AActivityspace
is null
.java.lang.String GetCurrentCommunityPageName(AActivitySpace owner) throws XPIllegalArgumentException
owner
- Current Activityspace.
XPIllegalArgumentException
- If the provided AActivityspace
is null
int GetCurrentCommunityID(AActivitySpace owner)
TaskAPIUICommon.INVALID_OBJECTID
is returned.
owner
- Current Activityspace
TaskAPIUICommon.INVALID_OBJECTID
if not in a Community.
XPIllegalArgumentException
- If the provided AActivityspace
is null
int GetCurrentCommunityPageID(AActivitySpace owner) throws XPIllegalArgumentException
TaskAPIUICommon.INVALID_OBJECTID
value is returned.
owner
- Current Activityspace.
TaskAPIUICommon.INVALID_OBJECTID
if not in on Community Page.
XPIllegalArgumentException
- If the provided AActivityspace
is null
.IPTURL GetCurrentPageAsURL(AActivitySpace owner) throws XPIllegalArgumentException
IPTURL
. Returns
owner
- Current Activityspace
XPIllegalArgumentException
XPArrayList GetCurrentSubCommunitiesAsURLs(AActivitySpace owner)
XPArrayList
with IPTURL
entries.
owner
- Current Activityspace.
IPTURL
of Subcommunities. An empty list is returned if there are
no subcommunities exist or not in a Community.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.IPTURL GetURLForUnsubscribeCommunitiesEditor(AActivitySpace owner)
owner
- Current Activityspace.
IPTURL
with URL to the Unsubscribe from Communities Editor, or null
if the URL is not
valid in the current context.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.IPTURL GetURLForCurrentCommunityEditor(AActivitySpace owner)
owner
- Current Activityspace.
IPTURL
with URL to the Editor for the current Community, or null
if the URL is not
valid in the current context.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.XPArrayList GetURLForCurrentCommunity(AActivitySpace owner)
owner
- Current Activityspace.
XPArrayList
list containing a single URL to the current Community,
or null
if the URL is not valid in the current context.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.IPTURL GetURLForAddCommunityPortletsEditor(AActivitySpace owner)
owner
- Current Activityspace.
IPTURL
with URL to the Community Add Portlets Editor, or null
if the URL is not
valid in the current context.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.IPTURL GetURLForAddCommunityPortletsFlyout(AActivitySpace owner)
owner
- Current Activityspace.
IPTURL
with URL to the Community Add Portlets Flyout, or null
if the URL is not
valid in the current context.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.IPTURL GetURLForCreateCommunityPage(AActivitySpace owner)
owner
- Current Activityspace.
IPTURL
with URL to Create Community Page in the Community Editor,
or null
if the URL is not valid in the current context.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.IPTURL GetURLForCreateCommunityPageOneClick(AActivitySpace owner, boolean bInheritTemplate, int nPageTemplate)
owner
- Current Activityspace.
IPTURL
with URL to Create Community Page in the Community Editor,
or null
if the URL is not valid in the current context.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.IPTURL GetURLForJoinCommunitiesEditor(AActivitySpace owner)
owner
- Current Activityspace.
IPTURL
with URL to the Join Communities Editor, or null
if the URL is not
valid in the current context.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.IPTURL GetURLForEditPortletPreferencesEditor(AActivitySpace owner)
owner
- Current Activityspace.
IPTURL
with URL to the Community Edit Portlet Preferences Editor, or null
if the URL is not
valid in the current context.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.boolean IsUserMemberOfCurrentCommunity(AActivitySpace owner)
owner
- Current activityspace.
true
if current Community is already subscribed by the user, false
if not member, or on User profile community
or not or if not currently in a Community.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.boolean IsCurrentPageCommunityPage(AActivitySpace owner)
owner
- Current Activityspace.
true
if the current page is a Community Page, false
otherwise.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.boolean IsCurrentCommunityUserProfileCommunity(AActivitySpace owner)
owner
- Current Activityspace.
true
if the current Community is the User Profile Community, false
otherwise.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.boolean IsCurrentUserAbleToEditCurrentCommunityPage(AActivitySpace owner)
owner
- Current Activityspace.
true
if the current user has at least EDIT access to the current Community Page, false
otherwise.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.boolean IsCurrentUserCommunityOwner(AActivitySpace owner)
owner
- Current Activityspace.
true
if the current user has at least EDIT access to the current Community, false
otherwise.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.boolean IsUserAbleToJoinCurrentCommunity(AActivitySpace owner)
owner
- Current Activityspace.
true
if the current user has at least SELECT access to the current Community, false
otherwise.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.boolean IsUserAbleToAccessCurrentCommunity(AActivitySpace owner)
owner
- Current Activityspace.
true
if the current user has at least READ access to the current Community, false
otherwise.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.boolean IsCurrentPageMyPortalPage(AActivitySpace owner)
owner
- Current Activityspace.
true
if the current page is either a MyPage or Community Page, false
otherwise.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.XPArrayList GetCommunityActionsAsURLs(AActivitySpace owner)
owner
- Current Activityspace.
XPArrayList
with IPTURL
entries with Community Actions.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.XPArrayList GetCommunityActionsAsURLs(AActivitySpace owner, boolean bIncludeOneClick, boolean bInheritTemplate, int nPageTemplate)
owner
- Current Activityspace.includeOneClick
- Flag to include the "one-click page creation" link
XPArrayList
with IPTURL
entries with Community Actions.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.IPTURL CreateCommunityCommonOpenerURL(AActivitySpace owner, int nCommunityID, java.lang.String strCommunityName)
PTURLConstants.KEY_CURRENTMARKER
flag is set on the URL if is leading to the current
Community.
owner
- Current Activityspace.nCommunityID
- Object ID of the Community to create an URL to.strCommunityName
- Name of the URL, normally the name of the Community.
IPTURL
with an URL to the specified Community.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.IPTURL CreateCommunityPageCommonOpenerURL(AActivitySpace owner, int nCommunityID, int nCommunityPageID, java.lang.String strCommunityPageName)
PTURLConstants.KEY_CURRENTMARKER
flag is set on the URL if is leading to the current
Community Page. In case the page is a profile page, the link generated will be of the viewed profile,
not the current user's.
owner
- Current Activityspace.nCommunityID
- Object ID of the Community where the Page is located in.nCommunityPageID
- Object ID of the Page to create a URL to.strCommunityPageName
- Title of the URL, normally the name of the Page.
IPTURL
with an URL to the specified Community Page.
XPIllegalArgumentException
- If the user does not have sufficient access to the Community.IPTURL CreateUserProfilePageCommonOpenerURL(AActivitySpace owner, int nProfileUserID, java.lang.String sProfileUserName)
owner
- Current Activityspace.nProfileUserID
- The Object ID of the user to open the User Profile page for.sProfileUserName
- The name of the user to open the User Profile page for. Also used for the link title.
IPTURL
with the URL to the user profile page for the specified user.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.IPTURL CreateUserProfilePageCommonOpenerURL(AActivitySpace owner, int nProfileUserID, java.lang.String sProfileUserName, java.lang.String strURLTitle)
owner
- Current Activityspace.nProfileUserID
- The Object ID of the user to open the User Profile page for.sProfileUserName
- The name of the user to open the User Profile page for.strURLTitle
- The title of the URL.
IPTURL
with the URL to the user profile page for the specified user.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.IPTURL CreateUserProfilePageCommonOpenerURL(AActivitySpace owner, int nProfileUserID, java.lang.String sProfileUserName, java.lang.String strURLTitle, int nPageId, java.lang.String strPageName)
owner
- Current Activityspace.nProfileUserID
- The Object ID of the user to open the User Profile page for.sProfileUserName
- The name of the user to open the User Profile page for.strURLTitle
- The title of the URL.
IPTURL
with the URL to the user profile page for the specified user.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.boolean CheckUserAccessLevelToCommunity(AActivitySpace owner, int nAccessLevel, int nCommunityID)
AccessLevel
- to check for. Example: PT_ACCESS_LEVELS.PT_ACCESS_LEVEL_READ or PT_ACCESS_LEVELS.PT_ACCESS_LEVEL_SELECTnCommunityID
- Object ID of the Community to check security of
XPIllegalAccessException
- If the user does not have sufficient access to the Community.PT_ACCESS_LEVELS
boolean CheckUserAccessLevelToCurrentCommunity(AActivitySpace owner, int nAccessLevel)
AccessLevel
- to check for. Example: PT_ACCESS_LEVELS.PT_ACCESS_LEVEL_READ or PT_ACCESS_LEVELS.PT_ACCESS_LEVEL_SELECT
XPIllegalAccessException
- If the user does not have sufficient access to the Community.PT_ACCESS_LEVELS
boolean CheckUserAccessLevelToCurrentCommunityPage(AActivitySpace owner, int nAccessLevel)
AccessLevel
- to check for. Example: PT_ACCESS_LEVELS.PT_ACCESS_LEVEL_READ or PT_ACCESS_LEVELS.PT_ACCESS_LEVEL_SELECT
XPIllegalAccessException
- If the user does not have sufficient access to the Community.PT_ACCESS_LEVELS
int GetParentCommunityID(AActivitySpace owner, int nCommunityID)
owner
- Current Activityspace.nCommunityID
- Object ID of the Community to get the parent Community from.
0 /code> if non-existant.
- Throws:
XPIllegalAccessException
- If the user does not have sufficient access to the Community.
int GetCurrentParentCommunityID(AActivitySpace owner)
owner
- Current Activityspace.
0
if not currently in a Community or
the current Community does not have a parent Community.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.int[] GetCurrentRelatedCommununityIDs(AActivitySpace owner)
owner
- Current Activityspace.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.IPTURL GetURLForJoinCurrentCommunityAction(AActivitySpace owner)
owner
- Current Activityspace.
IPTURL
to join current community or null
if the current user is already a member or does not have access to join the current community.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.IPTURL GetURLForUnsubscribeCurrentCommunityAction(AActivitySpace owner)
owner
- Current Activityspace.
IPTURL
to unsubscribe current community or null
if the current user is already not a member or does not have access to unsubscribe the current community.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.int[] GetCurrentSubCommunityIDs(AActivitySpace owner)
owner
- Current Activityspace.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.XPArrayList GetCurrentCommunityPagesAsURLs(AActivitySpace owner)
XPArraylist
with IPTURL
entries.
owner
- Current Activityspace.
XPArrayList
with IPTURL
to CommunityPages, or empty XPArrayList
if the current page is not a Community Page or valid Page.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.XPArrayList GetCurrentRelatedCommunitiesAsURLs(AActivitySpace owner)
IPTURL
s.
Related Communities are Communities in the same administrative folder.
owner
- Current Activityspace.
XPArrayList
with IPTURL
s to Related Communities or an empty XPArrayList
if none exists.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.IPTURL GetCurrentParentCommunityAsURL(AActivitySpace owner)
owner
- Current Activityspace.
null
if no parent Community exists, or if not currently
in a Community.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.IPTURL GetParentCommunityAsURL(AActivitySpace owner, int nCommunityID)
owner
- Current Activityspace.nCommunityID
-
null
if no parent Community exists, or if the
specified Community is invalid.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.XPArrayList GetSubCommununitiesAsURLs(AActivitySpace owner, int nCommunityID)
IPTURL
entries.
Subcommunities are Community located below another Community in the administrative hierarchy.
owner
- Current Activityspace.nCommunityID
- Object ID for the Community to get Subcommunities from.
XPArrayList
with IPTURL
entries to Subcommunities, or
empty array if the specified Community does no thave any Subcommunities or it is invalid.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.int GetDefaultCommunityID(AActivitySpace owner)
owner
- Current Activityspace.
-1
if
the user is not a member of any communities.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.XPArrayList GetMyCommunitiesAsURLs(AActivitySpace owner, boolean bUseCachedData)
XPArrayList
with IPTURL
entries.
The PTURLConstants.KEY_CURRENTMARKER
flag is set on an URL entry if is leading to the current
Community.
owner
- Current Activityspace.bUseCachedData
- Get the current user's mandatory Communities with Tabs from a cache that contains at
most 15 minutes old data if true. Will query the database for the mandatory communities if false.
XPArrayList
with IPTURL
s to the current user's My Communities ,
or null
if Communities features is disabled in the current Experience Definition.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.XPArrayList GetMyMandatoryCommunitiesWithTabsAsURLs(AActivitySpace owner, boolean bUseCachedData)
XPArrayList
with IPTURL
entries.
owner
- Current Activityspace.bUseCachedData
- Get the current user's mandatory Communities with Tabs from a cache that contains at most 15 minutes old data if true. Will query the database
for the mandatory communities if false.
XPArrayList
with IPTURL
s to the current user's mandatory Communities with Tabs,
or null
if Communities features is disabled in the current Experience Definition.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.int GetCommunityIDFromPTURL(IPTURL ptURL)
ptURL
- IPTURL
to a Community or Community Page.
0
if none is found in the URL.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.int GetCommunityPageIDFromPTURL(IPTURL ptURL)
ptURL
- IPTURL
to a Community Page.
0
if none is found in the URL.
XPIllegalAccessException
- If the user does not have sufficient access to the Community.boolean IsCommunityMember(AActivitySpace _asOwner, int _nCommunityID)
_asOwner
- the current Activity Space_nCommunityID
- the community to check membership for.
boolean JoinCommunity(AActivitySpace _asOwner, int _nCommunityID) throws XPException
_asOwner
- the current Activity Space_nCommunityID
- the community to join.
XPException
- if there was an error.boolean LeaveCommunity(AActivitySpace _asOwner, int _nCommunityID) throws XPException
_asOwner
- the current Activity Space_nCommunityID
- the community to leave.
XPException
- if there was an error.
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |