com.plumtree.taskapi.portalui
Class TaskAPIUIMyPages

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

public class TaskAPIUIMyPages
extends java.lang.Object

MyPages related TaskAPI functions.

Constructor Summary

TaskAPIUIMyPages()

Method Summary

static IPTURL	CreateMyPageCommonOpenerURL(AActivitySpace owner, int nMyPageID, java.lang.String strURLTitle) Gets an IPTURL to the specified MyPage.
static int	GetCurrentMyPageID(AActivitySpace owner) Gets the object ID of the current MyPage.
static java.lang.String	GetCurrentMyPageName(AActivitySpace owner) Gets the current MyPage name.
static XPArrayList	GetMyPageActionsAsURLs(AActivitySpace owner) Gets the list of MyPages actions for the current user.
static XPArrayList	GetMyPageActionsAsURLs(AActivitySpace owner, boolean bIncludeOneClick) Gets the list of MyPages actions for the current user.
static int	GetMyPageIDFromPTURL(IPTURL ptURL) Helper function to retrieve the MyPage Object ID from a MyPage CommonOpenerOpenObjIDURL to a MyPage.
static XPArrayList	GetMyPagesAsURLs(AActivitySpace owner) Gets the list of the current user's MyPages
static IPTURL	GetURLForAddMyPagePortletsEditor(AActivitySpace owner) Gets the URL to the MyPage Add Portlets Editor.
static IPTURL	GetURLForAddMyPagePortletsFlyout(AActivitySpace owner) Gets the URL to the MyPage Add Portlets Flyout.
static IPTURL	GetURLForCreateMyPageEditor(AActivitySpace owner) Gets the URL for the Create MyPage Editor.
static IPTURL	GetURLForCreateMyPageOneClick(AActivitySpace owner) Gets the URL for the one-click MyPage creation
static IPTURL	GetURLForDeleteCurrentMyPageAction(AActivitySpace owner) Gets the URL for Deleting the current MyPage.
static IPTURL	GetURLForEditLayoutEditor(AActivitySpace owner) Gets the URL to the Edit current MyPage Editor for the Low-Bandwidth and Accessibility Style mode.
static IPTURL	GetURLForEditMyPageEditor(AActivitySpace owner) Gets the URL to the Edit current MyPage Editor for the Standard Access Style mode.
static IPTURL	GetURLForEditMyPagePortletPreferencesEditor(AActivitySpace owner) Gets the URL to the MyPage Edit Portlet Preference Editor.
static boolean	IsCurrentPageMyPage(AActivitySpace owner) Checks if the current page is a MyPage
static boolean	IsMaxMyPageLimitReached(AActivitySpace owner) Checks if the current user already has created the maximum number of MyPages (defined in PT_SERVERCONSTANTS.PT_MAX_MYPORTAL_PAGES.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskAPIUIMyPages

public TaskAPIUIMyPages()

Method Detail

CreateMyPageCommonOpenerURL

public static IPTURL CreateMyPageCommonOpenerURL(AActivitySpace owner,
                                                 int nMyPageID,
                                                 java.lang.String strURLTitle)

Gets an IPTURL to the specified MyPage.

Parameters:

owner - Current Activityspace.

nMyPageID - Object ID of the MyPage to create an URL to.

strURLTitle - Title of the URL, i.e. what a link using the URL will display. Most often, the MyPage name should be used.

Returns:

IPTURL with an URL to the specified MyPage.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null or not valid.

GetMyPagesAsURLs

public static XPArrayList GetMyPagesAsURLs(AActivitySpace owner)

Gets the list of the current user's MyPages

Parameters:

owner - Current Activityspace.

Returns:

XPArrayList with IPTURL entries to the current user's MyPages, or null when MyPages should not be displayed, i.e. if MyPages feature is disabled in the current Experience Definition or on Preview pages.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null or not valid.

GetMyPageActionsAsURLs

public static XPArrayList GetMyPageActionsAsURLs(AActivitySpace owner)

Gets the list of MyPages actions for the current user.

Parameters:

owner - Current Activityspace.

Returns:

XPArrayList with IPTURL entries to the current user's MyPage Actions. Actions Edit MyPage Editor, Add MyPage Portlets Editor, and Edit MyPage Portlet Preferences Editor, and Delete Current MyPage are only displayed when on a MyPage.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null or not valid.

GetMyPageActionsAsURLs

public static XPArrayList GetMyPageActionsAsURLs(AActivitySpace owner,
                                                 boolean bIncludeOneClick)

Gets the list of MyPages actions for the current user.

Parameters:

owner - Current Activityspace.

bIncludeOneClick - indicates if the URL for one-click page creation should be included in the list. default is false.

Returns:

XPArrayList with IPTURL entries to the current user's MyPage Actions. Actions Edit MyPage Editor, Add MyPage Portlets Editor, and Edit MyPage Portlet Preferences Editor, and Delete Current MyPage are only displayed when on a MyPage.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null or not valid.

IsMaxMyPageLimitReached

public static boolean IsMaxMyPageLimitReached(AActivitySpace owner)

Checks if the current user already has created the maximum number of MyPages (defined in PT_SERVERCONSTANTS.PT_MAX_MYPORTAL_PAGES.

Parameters:

owner - Current Activityspace

Returns:

true if the maximum number of MyPages has been created for the current user, false otherwise.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null or not valid.

IsCurrentPageMyPage

public static boolean IsCurrentPageMyPage(AActivitySpace owner)

Checks if the current page is a MyPage

Parameters:

owner - Current Activityspace

Returns:

true if current page is a MyPage, false otherwise.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null

GetCurrentMyPageName

public static java.lang.String GetCurrentMyPageName(AActivitySpace owner)

Gets the current MyPage name. If current page is not a MyPage, a null value is returned.

Parameters:

owner -

Returns:

MyPage Name of the current MyPage or null value if not currently on a MyPage.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null or not valid.

GetURLForCreateMyPageEditor

public static IPTURL GetURLForCreateMyPageEditor(AActivitySpace owner)

Gets the URL for the Create MyPage Editor.

Parameters:

owner - Current Activityspace

Returns:

IPTURL with the URL to the Create MyPage Editor, or null if it URL is not valid in the current context. For example when MyPages feature is disabled in the current Experience Definition Editor, or the maximum number of MyPages has been reached.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null or not valid.

GetURLForCreateMyPageOneClick

public static IPTURL GetURLForCreateMyPageOneClick(AActivitySpace owner)

Gets the URL for the one-click MyPage creation

Parameters:

owner - Current Activityspace

Returns:

IPTURL with the URL to the one-click MyPage control, or null if it URL is not valid in the current context. For example when MyPages feature is disabled in the current Experience Definition Editor, or the maximum number of MyPages has been reached.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null or not valid.

GetURLForEditMyPageEditor

public static IPTURL GetURLForEditMyPageEditor(AActivitySpace owner)

Gets the URL to the Edit current MyPage Editor for the Standard Access Style mode.

Parameters:

owner - Current Activityspace.

Returns:

IPTURL with the URL to the current MyPage Editor, or nullif the URL is invalid in the current context. For example when MyPages feature is disabled in the current Experience Definition Editor.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null or not valid.

GetURLForEditLayoutEditor

public static IPTURL GetURLForEditLayoutEditor(AActivitySpace owner)

Gets the URL to the Edit current MyPage Editor for the Low-Bandwidth and Accessibility Style mode.

Parameters:

owner - Current Activityspace.

Returns:

IPTURL with the URL to the current MyPage Editor, or nullif the URL is invalid in the current context. For example when MyPages feature is disabled in the current Experience Definition Editor.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null or not valid.

GetURLForAddMyPagePortletsEditor

public static IPTURL GetURLForAddMyPagePortletsEditor(AActivitySpace owner)

Gets the URL to the MyPage Add Portlets Editor.

Parameters:

owner - Current Activityspace.

Returns:

IPTURL with the URL to the MyPage App Portlets Editor, or nullif the URL is invalid in the current context. For example when MyPages feature is disabled in the current Experience Definition Editor.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null or not valid.

GetURLForAddMyPagePortletsFlyout

public static IPTURL GetURLForAddMyPagePortletsFlyout(AActivitySpace owner)

Gets the URL to the MyPage Add Portlets Flyout.

Parameters:

owner - Current Activityspace.

Returns:

IPTURL with the URL to the MyPage App Portlets Flyout, or nullif the URL is invalid in the current context. For example when MyPages feature is disabled in the current Experience Definition Editor.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null or not valid.

GetURLForEditMyPagePortletPreferencesEditor

public static IPTURL GetURLForEditMyPagePortletPreferencesEditor(AActivitySpace owner)

Gets the URL to the MyPage Edit Portlet Preference Editor.

Parameters:

owner - Current Activityspace.

Returns:

IPTURL with the URL to the MyPage Edit Portlet Preferences Editor, or nullif the URL is invalid in the current context. For example when MyPages feature is disabled in the current Experience Definition Editor.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null or not valid.

GetURLForDeleteCurrentMyPageAction

public static IPTURL GetURLForDeleteCurrentMyPageAction(AActivitySpace owner)

Gets the URL for Deleting the current MyPage.

Parameters:

owner - Current Activityspace.

Returns:

IPTURL with the URL to delete the current MyPage, or nullif the URL is invalid in the current context. For example when MyPages feature is disabled in the current Experience Definition Editor, or if the current MyPage is the only MyPage.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null or not valid.

GetCurrentMyPageID

public static int GetCurrentMyPageID(AActivitySpace owner)

Gets the object ID of the current MyPage.

Parameters:

owner - Current Activityspace.

Returns:

Object ID of the MyPage, or 0 if not currently on a MyPage.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null or not valid.

GetMyPageIDFromPTURL

public static int GetMyPageIDFromPTURL(IPTURL ptURL)

Helper function to retrieve the MyPage Object ID from a MyPage CommonOpenerOpenObjIDURL to a MyPage.

Parameters:

ptURL - An IPTURL to a MyPage

Returns:

The MyPage ID as an int or 0 if the provided URL is not a CommonOpenerOpenObjIDURLor MyPage URL.

Throws:

XPIllegalArgumentException - if the provided AActivityspace is null or not valid.