com.plumtree.uiinfrastructure.opener
Class OpenerLinks

java.lang.Object
  com.plumtree.uiinfrastructure.opener.OpenerLinks

Direct Known Subclasses:

PTOpenerLinks

public class OpenerLinks
extends java.lang.Object

This helper object enables client programmers to easily and generically open objects throughout the system.

Field Summary

static int

INT_PARAM_EXCLUDEVALUE

Constructor Summary

OpenerLinks()

Method Summary

static java.lang.String	GetOpenerURL(java.lang.String _strQSArgs, int _nOpenerMode, AActivitySpace _asOwner) Returns an URL that opens the specified object.
static java.lang.String	GetOpenerURL(java.lang.String _strQSArgs, int _nOpenerMode, java.lang.String _strApplicationBaseURL, java.lang.String _strUserID) Returns an URL that opens the specified object.
static java.lang.String	GetOpenerURLOpenAS(java.lang.String _strASName, int _nOpenerMode, AActivitySpace _asOwner) Returns an URL that opens the specified Activity Space.
static java.lang.String	GetOpenerURLOpenAS(java.lang.String _strASName, int _nOpenerMode, AActivitySpace _asOwner, java.lang.String _strOverrideParentSpaceName, java.lang.String _strOverrideParentSpaceID, java.lang.String _strOptQSArgs) Returns an URL that opens the specified Activity Space.
static java.lang.String	GetOpenerURLOpenAS(java.lang.String _strASName, java.lang.String _strOptQSArgs, int _nOpenerMode, java.lang.String _strApplicationBaseURL, int _nUserID) Returns an URL that opens the specified Activity Space.
static java.lang.String	GetWindowName(java.lang.String _strNameKey) Helper method to generate the window name based on the specified key.

Methods inherited from class java.lang.Object

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

Field Detail

INT_PARAM_EXCLUDEVALUE

public static final int INT_PARAM_EXCLUDEVALUE

See Also:

Constant Field Values

Constructor Detail

OpenerLinks

public OpenerLinks()

Method Detail

GetOpenerURLOpenAS

public static final java.lang.String GetOpenerURLOpenAS(java.lang.String _strASName,
                                                        int _nOpenerMode,
                                                        AActivitySpace _asOwner)

Returns an URL that opens the specified Activity Space. If you do not specify the mode to open the object in, the default mode for that class will be used. By default, the Application Base URL and User ID will be retrieved from the AS owner. If you want to use alternate values, or remove the User ID from the URL, you need to use the base GetOpenerURL method. Additionally, the ParentSpace Name and ID will also be placed onto the URL and these too will be retrieved from the AS. If you want to change the location of the Parent or remove it from the URL, you can use the overloaded method of the same name.

Parameters:

_strASName - Name of the Activity Space to open.

_nOpenerMode - Mode to open object in, use OpenerAs.INT_PARAM_EXCLUDEVALUE constan to exclude.

_asOwner - AS to retrieve information from.

Returns:

URL that opens the specified Activity Space.

GetOpenerURLOpenAS

public static final java.lang.String GetOpenerURLOpenAS(java.lang.String _strASName,
                                                        int _nOpenerMode,
                                                        AActivitySpace _asOwner,
                                                        java.lang.String _strOverrideParentSpaceName,
                                                        java.lang.String _strOverrideParentSpaceID,
                                                        java.lang.String _strOptQSArgs)

Returns an URL that opens the specified Activity Space. If you do not specify the mode to open the object in, the default mode for that class will be used. By default, the Application Base URL and User ID will be retrieved from the AS owner. If you want to use alternate values, or remove the User ID from the URL, you need to use the base GetOpenerURL method.

Parameters:

_strASName - Name of the Activity Space to open.

_nOpenerMode - Mode to open object in, use OpenerAs.INT_PARAM_EXCLUDEVALUE constan to exclude.

_asOwner - AS to retrieve information from.

_strOverrideParentSpaceName - Alternative ParentSpaceName to use, NULL to exclude.

_strOverrideParentSpaceID - Alternative ParentSpaceID to use, NULL to exclude.

_strOptQSArgs - Additional arguments to add to the URL, NULL to exclude.

Returns:

URL that opens the specified Activity Space.

GetOpenerURLOpenAS

public static final java.lang.String GetOpenerURLOpenAS(java.lang.String _strASName,
                                                        java.lang.String _strOptQSArgs,
                                                        int _nOpenerMode,
                                                        java.lang.String _strApplicationBaseURL,
                                                        int _nUserID)

Returns an URL that opens the specified Activity Space. If you do not specify the mode to open the object in, the default mode for that class will be used. This method takes in optional QS arguments. Therefore no arguments (i.e. ParentSpaceName/ParentSpaceID), etc will be set for you. You must specify all arguments using the QSArgs argument.

Parameters:

_strASName - Name of the Activity Space to open.

_strOptQSArgs - Arguments to use for opening the object, NULL to exclude.

_nOpenerMode - Mode to open object in, use OpenerAs.INT_PARAM_EXCLUDEVALUE constant to exclude.

_strApplicationBaseURL - The Application Base URL.

_nUserID - User ID to append to the URL, use OpenerAs.INT_PARAM_EXCLUDEVALUE constant to exclude.

Returns:

URL that opens the specified object, generically.

GetOpenerURL

public static final java.lang.String GetOpenerURL(java.lang.String _strQSArgs,
                                                  int _nOpenerMode,
                                                  AActivitySpace _asOwner)

Returns an URL that opens the specified object. If you do not specify the mode to open the object in, the default mode for that class will be used. Note that you need to provide both the QS name and value pair in the QSArgs argument (the extended GetOpenerURLXXX methods do this for you automatically). By default, the Application Base URL and User ID will be retrieved from the AS owner. If you want to use alternate values, or remove the User ID from the URL, you need to use the base GetOpenerURL method. See the base GetOpenerURL method for what else is added to the URL.

Parameters:

_strQSArgs - Arguments to use for opening the object.

_nOpenerMode - Mode to open object in, use OpenerAs.INT_PARAM_EXCLUDEVALUE constan to exclude.

_asOwner - AS to retrieve information from.

Returns:

URL that opens the specified object, generically.

GetOpenerURL

public static final java.lang.String GetOpenerURL(java.lang.String _strQSArgs,
                                                  int _nOpenerMode,
                                                  java.lang.String _strApplicationBaseURL,
                                                  java.lang.String _strUserID)

Returns an URL that opens the specified object. If you do not specify the mode to open the object in, the default mode for that class will be used. Note that you need to provide both the QS name and value pair in the QSArgs argument (the extended GetOpenerURLXXX methods do this for you automatically). This is the base GetOpenerURL method. You will need to provide the Application Base URL and the User ID, as well as any other information that you want to add to the URL, such as the ParentSpace arguments. Nothing else is added to the URL, you must specify all arguments using the QSArgs argument.

Parameters:

_strQSArgs - Arguments to use for opening the object.

_nOpenerMode - Mode to open object in, use OpenerAs.INT_PARAM_EXCLUDEVALUE constan to exclude.

_strApplicationBaseURL - The Application Base URL.

_strUserID - User ID to append to the URL, use OpenerAs.INT_PARAM_EXCLUDEVALUE constant to exclude.

Returns:

URL that opens the specified object, generically.

GetWindowName

public static final java.lang.String GetWindowName(java.lang.String _strNameKey)

Helper method to generate the window name based on the specified key. The key is generally a string that can uniquely identify the object you are opening the window for, such as the UUID, or the ClassID/ObjectID pair.

Parameters:

_strNameKey - Key to use to generate the window name.

Returns:

A window name based on the specified key.