com.plumtree.portaluiinfrastructure.ptlink
Class ACommonOpenerURL

java.lang.Object
  com.plumtree.portaluiinfrastructure.ptlink.PTURLConstants
      com.plumtree.portaluiinfrastructure.ptlink.APTURL
          com.plumtree.portaluiinfrastructure.ptlink.ACommonOpenerURL

All Implemented Interfaces:

IPTURL, IDataObject, IHierarchicalDataObject

Direct Known Subclasses:

CommonOpenerFriendlyURL, CommonOpenerOpenASURL, CommonOpenerOpenObjIDURL

public abstract class ACommonOpenerURL
extends APTURL
implements IDataObject

Abstract class that defines common CommonOpenerURL data and functions.

Field Summary

static java.lang.String	KEY_COMMONOPENER_APPBASEURL Constant to get/set baseurl.
static java.lang.String	KEY_COMMONOPENER_OPENERMODE Constant to get/set common opener mode.
static java.lang.String	KEY_COMMONOPENER_USERID Constant to get/set user id.
protected int	m_nOpenerMode
protected int	m_nUserID
protected java.lang.String	m_strApplicationBaseURL

Fields inherited from class com.plumtree.portaluiinfrastructure.ptlink.APTURL

m_children, m_ClassID, m_IconAlt, m_IconHeight, m_IconImg, m_IconWidth, m_jsaction, m_listParamNames, m_listParamValues, m_MarkedAsCurrent, m_nonControlParamNames, m_nonControlParamValues, m_ObjectID, m_Title

Fields inherited from class com.plumtree.portaluiinfrastructure.ptlink.PTURLConstants

KEY_CLASSID, KEY_CURRENTMARKER, KEY_FULLURL, KEY_ICONIMG, KEY_ICONIMGALT, KEY_ICONIMGHEIGHT, KEY_ICONIMGWIDTH, KEY_JAVASCRIPT_ACTION, KEY_OBJECTID, KEY_PARAMS, KEY_TITLE, KEY_URI, KEY_URLTYPE

Constructor Summary

ACommonOpenerURL(java.lang.String strTitle, java.lang.String strApplicationBaseURL)
Constructor with no Opener mode or user id.

ACommonOpenerURL(java.lang.String strTitle, java.lang.String strApplicationBaseURL, int nUserID)
Constructor with no Opener mode.

ACommonOpenerURL(java.lang.String strTitle, java.lang.String strApplicationBaseURL, int nMode, int nUserID)
Constructor

Method Summary

java.lang.String	GetData(java.lang.String strKey) Supports KEY_COMMONOPENER_APPBASEURL and KEY_COMMONOPENER_USERID constants.
abstract java.lang.String	GetFullURL() Returns the entire URL with http:// and server name E.g http://portalserver/portal/server.pt
abstract java.lang.String	GetURI() Returns the URI, the part of the URL after sever name E.g /portal/server.pt
void	SetURLData(java.lang.String strKey, java.lang.String strValue) Supports KEY_COMMONOPENER_APPBASEURL and KEY_COMMONOPENER_USERID constants.

Methods inherited from class com.plumtree.portaluiinfrastructure.ptlink.APTURL

AddControlParameter, AddControlParameter, AddNonControlParameter, GetHierData, SetHierData, SetURLImageType

Methods inherited from class java.lang.Object

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

Field Detail

KEY_COMMONOPENER_APPBASEURL

public static final java.lang.String KEY_COMMONOPENER_APPBASEURL

Constant to get/set baseurl.

See Also:

Constant Field Values

KEY_COMMONOPENER_USERID

public static final java.lang.String KEY_COMMONOPENER_USERID

Constant to get/set user id.

See Also:

Constant Field Values

KEY_COMMONOPENER_OPENERMODE

public static final java.lang.String KEY_COMMONOPENER_OPENERMODE

Constant to get/set common opener mode.

See Also:

Constant Field Values

m_strApplicationBaseURL

protected java.lang.String m_strApplicationBaseURL

m_nOpenerMode

protected int m_nOpenerMode

m_nUserID

protected int m_nUserID

Constructor Detail

ACommonOpenerURL

public ACommonOpenerURL(java.lang.String strTitle,
                        java.lang.String strApplicationBaseURL)

Constructor with no Opener mode or user id.

Parameters:

strTitle - URL title

strApplicationBaseURL - Application Base URL, E.g. http://www.plumtree.com:8000.

ACommonOpenerURL

public ACommonOpenerURL(java.lang.String strTitle,
                        java.lang.String strApplicationBaseURL,
                        int nMode,
                        int nUserID)

Constructor

Parameters:

strTitle - URL title

strApplicationBaseURL - Application Base URL, E.g. http://www.plumtree.com:8000.

nMode - CommonOpener mode.

nUserID - User ID.

ACommonOpenerURL

public ACommonOpenerURL(java.lang.String strTitle,
                        java.lang.String strApplicationBaseURL,
                        int nUserID)

Constructor with no Opener mode.

Parameters:

strTitle - URL title

strApplicationBaseURL - Application Base URL, E.g. http://www.plumtree.com:8000.

nUserID - User ID.

Method Detail

GetFullURL

public abstract java.lang.String GetFullURL()

Description copied from class: APTURL

Returns the entire URL with http:// and server name E.g http://portalserver/portal/server.pt

Specified by:

GetFullURL in interface IPTURL

Specified by:

GetFullURL in class APTURL

See Also:

IPTURL.GetFullURL()

GetURI

public abstract java.lang.String GetURI()

Description copied from class: APTURL

Returns the URI, the part of the URL after sever name E.g /portal/server.pt

Specified by:

GetURI in interface IPTURL

Specified by:

GetURI in class APTURL

See Also:

IPTURL.GetURI()

GetData

public java.lang.String GetData(java.lang.String strKey)

Supports KEY_COMMONOPENER_APPBASEURL and KEY_COMMONOPENER_USERID constants.

Specified by:

GetData in interface IDataObject

Overrides:

GetData in class APTURL

Parameters:

strKey - The key for the requested data

Returns:

String The requested data

See Also:

APTURL.GetData(java.lang.String)

SetURLData

public void SetURLData(java.lang.String strKey,
                       java.lang.String strValue)

Supports KEY_COMMONOPENER_APPBASEURL and KEY_COMMONOPENER_USERID constants.

Specified by:

SetURLData in interface IPTURL

Overrides:

SetURLData in class APTURL

Parameters:

strKey - Key of the data

strValue - Value of the data

See Also:

APTURL.SetURLData(java.lang.String, java.lang.String)