com.plumtree.portaluiinfrastructure.opener
Class PTOpenerLinks

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

public class PTOpenerLinks
extends OpenerLinks

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

Field Summary

Fields inherited from class com.plumtree.uiinfrastructure.opener.OpenerLinks

INT_PARAM_EXCLUDEVALUE

Constructor Summary

PTOpenerLinks()

Method Summary

static java.lang.String	GetJSOpenInNewWindow(java.lang.String _strURL, java.lang.String _strWindowName, java.lang.String _strWindowWidth, java.lang.String _strWindowHeight, boolean _bIsWindowFancy) Returns the JS method to open the specified URL in a new window.
static java.lang.String	GetJSOpenInSameWindow(java.lang.String _strURL) Returns the JS method to open the specified URL in the same window.
static HTMLScriptCollection	GetOpenerJavascript(AActivitySpace _asOwner) Returns the Javascript needed by the Common Opener.
static java.lang.String	GetOpenerJSURL(java.lang.String _strOptQSArgs, int _nOpenerMode) Overloaded method for easy access.
static java.lang.String	GetOpenerJSURL(java.lang.String _strQSArgs, java.lang.String _strOpenerMode) Returns the JS that will create an URL that opens the specified object.
static java.lang.String	GetOpenerJSURLOpenAS(java.lang.String _strASName, java.lang.String _strOptQSArgs, int _nOpenerMode) Overloaded method for easy access.
static java.lang.String	GetOpenerJSURLOpenAS(java.lang.String _strASName, java.lang.String _strOptQSArgs, java.lang.String _strOpenerMode) Returns the JS that will create an URL that opens the specified activity space.
static java.lang.String	GetOpenerJSURLOpenObjID(int _nClassID, int _nObjectID, java.lang.String _strOptQSArgs, int _nOpenerMode) Overloaded method for easy access.
static java.lang.String	GetOpenerJSURLOpenObjID(java.lang.String _strClassID, java.lang.String _strObjectID, java.lang.String _strOptQSArgs, java.lang.String _strOpenerMode) Returns the JS that will create an URL that opens the specified object.
static java.lang.String	GetOpenerJSURLOpenUUID(java.lang.String _strUUID, java.lang.String _strOptQSArgs, int _nOpenerMode) Overloaded method for easy access.
static java.lang.String	GetOpenerJSURLOpenUUID(java.lang.String _strUUID, java.lang.String _strOptQSArgs, java.lang.String _strOpenerMode) Returns the JS that will create an URL that opens the specified object.
static java.lang.String	GetOpenerURLCreate(int _nClassID, int _nFolderID, AActivitySpace _asOwner) Returns an URL that brings you to the location for creating an object of the specified class type.
static java.lang.String	GetOpenerURLCreate(int _nClassID, int _nFolderID, AActivitySpace _asOwner, java.lang.String _strOverrideParentSpaceName, java.lang.String _strOverrideParentSpaceID, java.lang.String _strOptQSArgs) Returns an URL that brings you to the location for creating an object of the specified class type.
static java.lang.String	GetOpenerURLCreateExt(int _nClassID, int _nFolderID, java.lang.String _strProvEngName, int _nDataSourceID, int _nWebServiceID, AActivitySpace _asOwner) Returns an URL that brings you to the location for creating an object of the specified class type.
static java.lang.String	GetOpenerURLCreateExt(int _nClassID, int _nFolderID, java.lang.String _strProvEngName, int _nDataSourceID, int _nWebServiceID, AActivitySpace _asOwner, java.lang.String _strOverrideParentSpaceName, java.lang.String _strOverrideParentSpaceID, java.lang.String _strOptQSArgs) Returns an URL that brings you to the location for creating an object of the specified class type.
static java.lang.String	GetOpenerURLOpenObjID(int _nClassID, int _nObjectID, int _nOpenerMode, AActivitySpace _asOwner) Returns an URL that opens the specified object.
static java.lang.String	GetOpenerURLOpenObjID(int _nClassID, int _nObjectID, int _nOpenerMode, AActivitySpace _asOwner, java.lang.String _strOverrideParentSpaceName, java.lang.String _strOverrideParentSpaceID, java.lang.String _strOptQSArgs) Returns an URL that opens the specified object.
static java.lang.String	GetOpenerURLOpenObjID(int _nClassID, int _nObjectID, java.lang.String _strObjectName, int _nOpenerMode, AActivitySpace _asOwner) Returns an URL that opens the specified object.
static java.lang.String	GetOpenerURLOpenObjID(int _nClassID, int _nObjectID, java.lang.String _strObjectName, int _nOpenerMode, AActivitySpace _asOwner, java.lang.String _strOverrideParentSpaceName, java.lang.String _strOverrideParentSpaceID, java.lang.String _strOptQSArgs) Returns an URL that opens the specified object.
static java.lang.String	GetOpenerURLOpenObjID(int _nClassID, int _nObjectID, java.lang.String _strOptQSArgs, int _nOpenerMode, java.lang.String _strApplicationBaseURL, int _nUserID) Returns an URL that opens the specified object.
static java.lang.String	GetOpenerURLOpenUUID(java.lang.String _strUUID, int _nOpenerMode, AActivitySpace _asOwner) Returns an URL that opens the specified object.
static java.lang.String	GetOpenerURLOpenUUID(java.lang.String _strUUID, int _nOpenerMode, AActivitySpace _asOwner, java.lang.String _strOverrideParentSpaceName, java.lang.String _strOverrideParentSpaceID, java.lang.String _strOptQSArgs) Returns an URL that opens the specified object.
protected static boolean	useFriendlyURLS(int openerMode, int classId, java.lang.String queryStringArgs) Checks whether to use friendly URLs or not from the provided arguments.

Methods inherited from class com.plumtree.uiinfrastructure.opener.OpenerLinks

GetOpenerURL, GetOpenerURL, GetOpenerURLOpenAS, GetOpenerURLOpenAS, GetOpenerURLOpenAS, GetWindowName

Methods inherited from class java.lang.Object

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

Constructor Detail

PTOpenerLinks

public PTOpenerLinks()

Method Detail

GetOpenerJavascript

public static HTMLScriptCollection GetOpenerJavascript(AActivitySpace _asOwner)

Returns the Javascript needed by the Common Opener. We add both dynamic script and static script. To provide a set of simpler API methods, some methods in the static script will call methods from the dynamic script. However, the static API will also include methods that don't depend on the dynamic API.

Returns:

This method returns the HTMLScript for the Common Opener.

GetOpenerURLCreate

public static final java.lang.String GetOpenerURLCreate(int _nClassID,
                                                        int _nFolderID,
                                                        AActivitySpace _asOwner)

Returns an URL that brings you to the location for creating an object of the specified class type. The object will be saved in specified folder. 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:

_nClassID - The ClassID of the object to create.

_nFolderID - The folder to save the object in.

_asOwner - AS to retrieve information from.

Returns:

URL that brings you to the location for creating an object.

GetOpenerURLCreate

public static final java.lang.String GetOpenerURLCreate(int _nClassID,
                                                        int _nFolderID,
                                                        AActivitySpace _asOwner,
                                                        java.lang.String _strOverrideParentSpaceName,
                                                        java.lang.String _strOverrideParentSpaceID,
                                                        java.lang.String _strOptQSArgs)

Returns an URL that brings you to the location for creating an object of the specified class type. The object will be saved in specified folder. 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:

_nClassID - The ClassID of the object to create.

_nFolderID - The folder to save the object in.

_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 brings you to the location for creating an object.

GetOpenerURLCreateExt

public static final java.lang.String GetOpenerURLCreateExt(int _nClassID,
                                                           int _nFolderID,
                                                           java.lang.String _strProvEngName,
                                                           int _nDataSourceID,
                                                           int _nWebServiceID,
                                                           AActivitySpace _asOwner)

Returns an URL that brings you to the location for creating an object of the specified class type. The object will be saved in specified folder. 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:

_nClassID - The ClassID of the object to create.

_nFolderID - The folder to save the object in.

_strProvEngName - English Provider Name, NULL to exclude.

_nDataSourceID - Datasource ID for this object, use OpenerLinks.INT_PARAM_EXCLUDEVALUE constan to exclude.

_nWebServiceID - WebService ID for this object, use OpenerLinks.INT_PARAM_EXCLUDEVALUE constan to exclude.

_asOwner - AS to retrieve information from.

Returns:

URL that brings you to the location for creating an extensible object.

GetOpenerURLCreateExt

public static final java.lang.String GetOpenerURLCreateExt(int _nClassID,
                                                           int _nFolderID,
                                                           java.lang.String _strProvEngName,
                                                           int _nDataSourceID,
                                                           int _nWebServiceID,
                                                           AActivitySpace _asOwner,
                                                           java.lang.String _strOverrideParentSpaceName,
                                                           java.lang.String _strOverrideParentSpaceID,
                                                           java.lang.String _strOptQSArgs)

Returns an URL that brings you to the location for creating an object of the specified class type. The object will be saved in specified folder. 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:

_nClassID - The ClassID of the object to create.

_nFolderID - The folder to save the object in.

_strProvEngName - English Provider Name, NULL to exclude.

_nDataSourceID - Datasource ID for this object, -1 to exclude.

_nWebServiceID - WebService ID for this object, -1 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 brings you to the location for creating an extensible object.

GetOpenerURLOpenUUID

public static final java.lang.String GetOpenerURLOpenUUID(java.lang.String _strUUID,
                                                          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 the UUID will be broken down by the Opener based on the UUID plugin. 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:

_strUUID - UUID of the object to open.

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

_asOwner - AS to retrieve information from.

Returns:

URL that opens the specified object.

GetOpenerURLOpenUUID

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

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 the UUID will be broken down by the Opener based on the UUID plugin. 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:

_strUUID - UUID of the object to open.

_nOpenerMode - Mode to open object in, use OpenerLinks.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 object.

GetOpenerURLOpenObjID

public static final java.lang.String GetOpenerURLOpenObjID(int _nClassID,
                                                           int _nObjectID,
                                                           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. Opening by ClassID/ObjectID pair is the simplest way. 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 A 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:

_nClassID - ClassID of the object to open.

_nObjectID - ObjectID of the object to open.

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

_asOwner - AS to retrieve information from.

Returns:

URL that opens the specified object.

GetOpenerURLOpenObjID

public static final java.lang.String GetOpenerURLOpenObjID(int _nClassID,
                                                           int _nObjectID,
                                                           java.lang.String _strObjectName,
                                                           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. Opening by ClassID/ObjectID pair is the simplest way. 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 A 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:

_nClassID - ClassID of the object to open.

_nObjectID - ObjectID of the object to open.

_strObjectName - Name of the object to open. Should be null if not used, but should always be passed in if available.

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

_asOwner - AS to retrieve information from.

Returns:

URL that opens the specified object.

GetOpenerURLOpenObjID

public static final java.lang.String GetOpenerURLOpenObjID(int _nClassID,
                                                           int _nObjectID,
                                                           int _nOpenerMode,
                                                           AActivitySpace _asOwner,
                                                           java.lang.String _strOverrideParentSpaceName,
                                                           java.lang.String _strOverrideParentSpaceID,
                                                           java.lang.String _strOptQSArgs)

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. Opening by ClassID/ObjectID pair is the simplest way. 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:

_nClassID - ClassID of the object to open.

_nObjectID - ObjectID of the object to open.

_nOpenerMode - Mode to open object in, use OpenerLinks.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 object.

GetOpenerURLOpenObjID

public static final java.lang.String GetOpenerURLOpenObjID(int _nClassID,
                                                           int _nObjectID,
                                                           java.lang.String _strObjectName,
                                                           int _nOpenerMode,
                                                           AActivitySpace _asOwner,
                                                           java.lang.String _strOverrideParentSpaceName,
                                                           java.lang.String _strOverrideParentSpaceID,
                                                           java.lang.String _strOptQSArgs)

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. Opening by ClassID/ObjectID pair is the simplest way. 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:

_nClassID - ClassID of the object to open.

_nObjectID - ObjectID of the object to open.

_strObjectName - Name of the object to open. Should be null if not used, but should always be passed in if available.

_nOpenerMode - Mode to open object in, use OpenerLinks.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 object.

GetOpenerURLOpenObjID

public static final java.lang.String GetOpenerURLOpenObjID(int _nClassID,
                                                           int _nObjectID,
                                                           java.lang.String _strOptQSArgs,
                                                           int _nOpenerMode,
                                                           java.lang.String _strApplicationBaseURL,
                                                           int _nUserID)

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. Opening by ClassID/ObjectID pair is the simplest way. 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:

_nClassID - ClassID of the object to open.

_nObjectID - ObjectID of the object to open.

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

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

_strApplicationBaseURL - The Application Base URL.

_nUserID - User ID to append to the URL, use OpenerLinks.INT_PARAM_EXCLUDEVALUE constan to exclude.

Returns:

URL that opens the specified object, generically.

GetOpenerJSURLOpenAS

public static final java.lang.String GetOpenerJSURLOpenAS(java.lang.String _strASName,
                                                          java.lang.String _strOptQSArgs,
                                                          java.lang.String _strOpenerMode)

Returns the JS that will create an URL that opens the specified activity space. If you choose to exclude the opener mode (using NULL), the default mode for that class will be used. Note that you need to provide both the QS name and value pairs in the OtpQSArgs argument (the extended GetOpenerJSXXX methods do this for you automatically). Note that this JS just generates the URL. You will need to wrap the URL with more JS (such as the GetJSOpenInXXX methods) if you want to do something useful with the URL. Note that you can generate URLS using the GetOpenerURL server methods, and then wrapping those URLS - these GetOpenerJSURL methods are useful primarly for dynamic JS work, or if you don't want to repeat values on the page. Note that the ApplicationBaseURL and CurrentUserID has already been placed on the page and thus do not need to be passed in.

Parameters:

_strASName - Name of AS to open.

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

_strOpenerMode - Mode to open object in, NULL to exclude.

Returns:

The JS that will generate an URL to open the specified object.

GetOpenerJSURLOpenAS

public static final java.lang.String GetOpenerJSURLOpenAS(java.lang.String _strASName,
                                                          java.lang.String _strOptQSArgs,
                                                          int _nOpenerMode)

Overloaded method for easy access. Refer to base class for JavaDoc.

See Also:

PTOpenerLinks#GetOpenerJSURLOpenAS(String, String, String, String)

GetOpenerJSURLOpenUUID

public static final java.lang.String GetOpenerJSURLOpenUUID(java.lang.String _strUUID,
                                                            java.lang.String _strOptQSArgs,
                                                            java.lang.String _strOpenerMode)

Returns the JS that will create an URL that opens the specified object. If you choose to exclude the opener mode (using NULL), the default mode for that class will be used. Note that you need to provide both the QS name and value pairs in the OtpQSArgs argument (the extended GetOpenerJSXXX methods do this for you automatically). Note that this JS just generates the URL. You will need to wrap the URL with more JS (such as the GetJSOpenInXXX methods) if you want to do something useful with the URL. Note that you can generate URLS using the GetOpenerURL server methods, and then wrapping those URLS - these GetOpenerJSURL methods are useful primarly for dynamic JS work, or if you don't want to repeat values on the page. Note that the ApplicationBaseURL and CurrentUserID has already been placed on the page and thus do not need to be passed in.

Parameters:

_strUUID - UUID of the object to open.

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

_strOpenerMode - Mode to open object in, NULL to exclude.

Returns:

The JS that will generate an URL to open the specified object.

GetOpenerJSURLOpenUUID

public static final java.lang.String GetOpenerJSURLOpenUUID(java.lang.String _strUUID,
                                                            java.lang.String _strOptQSArgs,
                                                            int _nOpenerMode)

Overloaded method for easy access. Refer to base class for JavaDoc.

See Also:

GetOpenerJSURLOpenUUID(String, String, String)

GetOpenerJSURLOpenObjID

public static final java.lang.String GetOpenerJSURLOpenObjID(java.lang.String _strClassID,
                                                             java.lang.String _strObjectID,
                                                             java.lang.String _strOptQSArgs,
                                                             java.lang.String _strOpenerMode)

Returns the JS that will create an URL that opens the specified object. If you choose to exclude the opener mode (using NULL), the default mode for that class will be used. Note that you need to provide both the QS name and value pairs in the OtpQSArgs argument (the extended GetOpenerJSXXX methods do this for you automatically). Note that this JS just generates the URL. You will need to wrap the URL with more JS (such as the GetJSOpenInXXX methods) if you want to do something useful with the URL. Note that you can generate URLS using the GetOpenerURL server methods, and then wrapping those URLS - these GetOpenerJSURL methods are useful primarly for dynamic JS work, or if you don't want to repeat values on the page. Note that the ApplicationBaseURL and CurrentUserID has already been placed on the page and thus do not need to be passed in.

Parameters:

_strClassID - ClassID of the object to open.

_strObjectID - ObjectID of the object to open.

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

_strOpenerMode - Mode to open object in, NULL to exclude.

Returns:

The JS that will generate an URL to open the specified object.

GetOpenerJSURLOpenObjID

public static final java.lang.String GetOpenerJSURLOpenObjID(int _nClassID,
                                                             int _nObjectID,
                                                             java.lang.String _strOptQSArgs,
                                                             int _nOpenerMode)

Overloaded method for easy access. Refer to base class for JavaDoc.

See Also:

GetOpenerJSURLOpenObjID(String, String, String, String)

GetOpenerJSURL

public static final java.lang.String GetOpenerJSURL(java.lang.String _strQSArgs,
                                                    java.lang.String _strOpenerMode)

Returns the JS that will create an URL that opens the specified object. If you choose to exclude the opener mode (using NULL), the default mode for that class will be used. Note that you need to provide both the QS name and value pairs in the OtpQSArgs argument (the extended GetOpenerJSXXX methods do this for you automatically). This is the base GetOpenerJSURL method. Besides the ApplicationBaseURL, the CurrentUserID and the OpenerMode, you will need to provide all of the other information you need to open your object. You must specify all of the other arguments using the QSArgs argument. Note that this JS just generates the URL. You will need to wrap the URL with more JS (such as the GetJSOpenInXXX methods) if you want to do something useful with the URL. Note that you can generate URLS using the GetOpenerURL server methods, and then wrapping those URLS - these GetOpenerJSURL methods are useful primarly for dynamic JS work, or if you don't want to repeat values on the page.

Parameters:

_strQSArgs - Arguments to use for opening the object.

_strOpenerMode - Mode to open object in, NULL to exclude.

Returns:

The JS that will generate an URL to open the specified object.

GetOpenerJSURL

public static final java.lang.String GetOpenerJSURL(java.lang.String _strOptQSArgs,
                                                    int _nOpenerMode)

Overloaded method for easy access. Refer to base class for JavaDoc.

See Also:

GetOpenerJSURL(String, String)

GetJSOpenInNewWindow

public static final java.lang.String GetJSOpenInNewWindow(java.lang.String _strURL,
                                                          java.lang.String _strWindowName,
                                                          java.lang.String _strWindowWidth,
                                                          java.lang.String _strWindowHeight,
                                                          boolean _bIsWindowFancy)

Returns the JS method to open the specified URL in a new window. The common use case is to use this in the onclick attribute of an HTML element.

Parameters:

_strURL - The URL to navigate to.

_strWindowName - Name of the new window.

_strWindowWidth - Width of the new window.

_strWindowHeight - Height of the new window.

_bIsWindowFancy - Windows can be fancy or not.

Returns:

The JS method for opening the URL in a new window.

GetJSOpenInSameWindow

public static final java.lang.String GetJSOpenInSameWindow(java.lang.String _strURL)

Returns the JS method to open the specified URL in the same window. The common use case is to use this in the onclick attribute of an HTML element.

Parameters:

_strURL - The URL to navigate to.

Returns:

The JS method for opening the URL in the same window.

useFriendlyURLS

protected static final boolean useFriendlyURLS(int openerMode,
                                               int classId,
                                               java.lang.String queryStringArgs)

Checks whether to use friendly URLs or not from the provided arguments.

Parameters:

openerMode - Opener Mode of the URL to check for

classId - Class id to the object type

queryStringArgs - Any additional query string arguments to add

Returns: