TaskAPIUICommunityService (Plumtree 6.1 Portal UI API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.plumtree.taskapi.portalui
Class TaskAPIUICommunityService

java.lang.Object
  com.plumtree.taskapi.portalui.TaskAPIUICommunityService

All Implemented Interfaces:: ITaskAPIUICommunity

public class TaskAPIUICommunityService
extends java.lang.Object
implements ITaskAPIUICommunity
extends java.lang.Object
implements ITaskAPIUICommunity

This class manages instances of the ITaskAPIUICommunity interface for both production and testing purposes. It is a replacement for the TaskAPIUICommunity class, since that class uses static methods and cannot be mocked for testing.

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.
`static ITaskAPIUICommunity`	`GetInstance()`
`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.
`static void`	`SetMockInstanceForDebug(ITaskAPIUICommunity _instance)` This method sets the debug instance of the ITaskAPIUIDirectory interface for use as a mock object.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

GetInstance

public static ITaskAPIUICommunity GetInstance()

Returns:: An instance of the ITaskAPIUIDirectory interface.

SetMockInstanceForDebug

public static void SetMockInstanceForDebug(ITaskAPIUICommunity _instance)

This method sets the debug instance of the ITaskAPIUIDirectory interface for use as a mock object. This should never be used in a production environment. This should be reset to null at the end of testing to ensure other code does not get an old mock instance.

Parameters:: _instance - The mock instance of the ITaskAPIUIDirectory interface. When the mock instance is done being used it should be reset to null by calling this method again with a null argument.