com.plumtree.taskapi.portalui
Class TaskAPIUISubPortal

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

public class TaskAPIUISubPortal
extends java.lang.Object

Experience Definition related TaskAPI functions.

Constructor Summary

TaskAPIUISubPortal()

Method Summary

static PTSortedArrayWrapper	CreateSortedArray(IPTQueryResult qrMandLinks, java.lang.String strLinkOrder, AActivitySpace owner) Internal helper function to create a PTSortedArrayWrapper object from a IPTQueryResult with Mandatory Experience Definition Link Data in a specified order .
static XPArrayList	GetSubPortalMandatoryLinksAsURLs(AActivitySpace owner) Gets a list of Mandatory Links URLs defined in the current Experience Definition.
static IPTURL	GetURLForMyHome(AActivitySpace owner) Gets the URL to the c urrent user's Home Page as defined in the current Experience Definition.
static boolean	IsSubPortalEnabledForAccessType(AActivitySpace owner, int nAccessType) Checks if the specified Feature type is enabled in the current Experience Definition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskAPIUISubPortal

public TaskAPIUISubPortal()

Method Detail

IsSubPortalEnabledForAccessType

public static boolean IsSubPortalEnabledForAccessType(AActivitySpace owner,
                                                      int nAccessType)

Checks if the specified Feature type is enabled in the current Experience Definition. The three feature types, also known as Access Types, are MyPage access, Communities access and Directory access.

Parameters:

owner - Current Activityspace.

nAccessType - One of the experience definition features defined in com.plumtree.server.PT_SUBPORTAL_ACCESS_TYPES.

Returns:

true if the current user has access to the specified feature, false in all other cases.

See Also:

PT_SUBPORTAL_ACCESS_TYPES

GetURLForMyHome

public static IPTURL GetURLForMyHome(AActivitySpace owner)

Gets the URL to the c urrent user's Home Page as defined in the current Experience Definition. Examples of Home Pages are a My Page, Community Pages or Knowledge Directory Folder.

Parameters:

owner - Current Activityspace

Returns:

IPTURL with URL to current user's Home Page or null if the Home Page could not be retrieved for any reason.

GetSubPortalMandatoryLinksAsURLs

public static XPArrayList GetSubPortalMandatoryLinksAsURLs(AActivitySpace owner)

Gets a list of Mandatory Links URLs defined in the current Experience Definition.

Parameters:

owner - Current Activityspace.

Returns:

XPArrayList with IPTURL entries to current user's Mandatory Experience Definition Links. An empty list is returned if there are no entries.

CreateSortedArray

public static PTSortedArrayWrapper CreateSortedArray(IPTQueryResult qrMandLinks,
                                                     java.lang.String strLinkOrder,
                                                     AActivitySpace owner)

Internal helper function to create a PTSortedArrayWrapper object from a IPTQueryResult with Mandatory Experience Definition Link Data in a specified order .

Parameters:

ptSiteMapFolderInfo - IPTQueryResult with Mandatory Experience Definition Links from TaskAPIServerSubPortal.GetSubPortalMyMandatoryLinks.

arrSort - A 2D int array of PropertyIDs to sort by. It should contain a column for each sort.

The first row holds the PropertyID. The list of supported property IDs defined in PT_PROPIDS: PT_PROPIDS.PT_PROPID_OBJECTID, PT_PROPIDS.PT_PROPID_SITEMAP_GID, PT_PROPIDS.PT_PROPID_NAME, PT_PROPIDS.PT_PROPID_DESCRIPTION, PT_PROPIDS.PT_PROPID_SITEMAP_LINKURL, PT_PROPIDS.PT_PROPID_SITEMAP_LINKCLASSID, PT_PROPIDS.PT_PROPID_SITEMAP_LINKOBJECTID, PT_PROPIDS.PT_PROPID_SITEMAP_LINKPAGEID;

The second row holds the sort direction, PTSortedArrayWrapper. PTSAW_SORT_ASCENDING or PTSortedArrayWrapper.PTSAW_SORT_DESCENDING

owner - Current Activityspace

Returns:

A PTSortedArrayWrapper object containing Mandatory Experience Definition Links in the specified order