com.plumtree.portaluiinfrastructure.intrinsicportlets.prefs
Class IntrinsicPortletPrefsUtils

java.lang.Object
  com.plumtree.portaluiinfrastructure.intrinsicportlets.prefs.IntrinsicPortletPrefsUtils

public class IntrinsicPortletPrefsUtils
extends java.lang.Object

Contains utility functions that deal with intrinsic portlets.

Author:

josephc

Field Summary

static java.lang.String	COMMUNITYID Query string constant for CommunityID
static java.lang.String	ISADMINPREF Query string constant for Admin type, 1 for true, 0 for false
static java.lang.String	PAGEID Query string constant for PageID
static java.lang.String	PORTLETID Query string constant for PortletID
static java.lang.String	PREFS_SUFFIX The prefs suffix is appended to the portlet class ID to form the name of prefs activity space.
static java.lang.String	SUBSPACE_KEY_SUFFIX Subspace key suffix for intrinsic portlets pref pages

Constructor Summary

IntrinsicPortletPrefsUtils()

Method Summary

static java.lang.String	GetAccessStyleComplientPortletPrefURL(java.lang.String _strURL, AActivitySpace _asOwner) Given a URL String remove psname & subspace control arguments from the query string.
static java.lang.String	GetClassIdentifier(IPTGadget _ptPortlet, IPTState _objAppData) Gets the portlet class identifier
static java.lang.String	GetHelpURL(IPTWebService _ptWebService) Constructs URL for accessing portlet help.
static ASURL	GetPrefsURL(IPTWebService _ptWebService, int _nPageID, int _nCommunityID, int _nPortletID, boolean isAdminPref, int _nAssociatedContentID, AActivitySpace asOwner) Constructs URL for accessing portlet preferences activity space.

Methods inherited from class java.lang.Object

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

Field Detail

PREFS_SUFFIX

public static final java.lang.String PREFS_SUFFIX

The prefs suffix is appended to the portlet class ID to form the name of prefs activity space.

See Also:

Constant Field Values

SUBSPACE_KEY_SUFFIX

public static final java.lang.String SUBSPACE_KEY_SUFFIX

Subspace key suffix for intrinsic portlets pref pages

See Also:

Constant Field Values

COMMUNITYID

public static final java.lang.String COMMUNITYID

Query string constant for CommunityID

See Also:

Constant Field Values

PAGEID

public static final java.lang.String PAGEID

Query string constant for PageID

See Also:

Constant Field Values

PORTLETID

public static final java.lang.String PORTLETID

Query string constant for PortletID

See Also:

Constant Field Values

ISADMINPREF

public static final java.lang.String ISADMINPREF

Query string constant for Admin type, 1 for true, 0 for false

See Also:

Constant Field Values

Constructor Detail

IntrinsicPortletPrefsUtils

public IntrinsicPortletPrefsUtils()

Method Detail

GetClassIdentifier

public static java.lang.String GetClassIdentifier(IPTGadget _ptPortlet,
                                                  IPTState _objAppData)

Gets the portlet class identifier

Parameters:

_ptPortlet - Portlet object

_objAppData - AppDataState object

Returns:

Portlet class identifier (which is also the activity space of portlet)

GetPrefsURL

public static ASURL GetPrefsURL(IPTWebService _ptWebService,
                                int _nPageID,
                                int _nCommunityID,
                                int _nPortletID,
                                boolean isAdminPref,
                                int _nAssociatedContentID,
                                AActivitySpace asOwner)

Constructs URL for accessing portlet preferences activity space.

Parameters:

_ptWebService - Web service object

_nPageID - Page ID

_nCommunityID - Community ID

_nPortletID - Portlet ID

_nAssociatedContentID - Associated content ID

asOwner - Activity space owner

Returns:

URL to preference page for intrinsic portlets

GetHelpURL

public static java.lang.String GetHelpURL(IPTWebService _ptWebService)

Constructs URL for accessing portlet help.

Parameters:

_ptWebService - Web service object

Returns:

URL to help page for intrinsic portlets

GetAccessStyleComplientPortletPrefURL

public static java.lang.String GetAccessStyleComplientPortletPrefURL(java.lang.String _strURL,
                                                                     AActivitySpace _asOwner)

Given a URL String remove psname & subspace control arguments from the query string. Use this method only when generating a link to a portlet prefs page from an intrinsic portlet which may be in 508 mode where these arguemnts confuse the control flow.

Parameters:

_strURL - a URL string to a portlet pref page

_asOwner - the current activity space

Returns:

a new URL String without the psname and subspace control arguments