|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.opener.OpenerLinks com.plumtree.portaluiinfrastructure.opener.PTOpenerLinks
public class PTOpenerLinks
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 |
---|
public PTOpenerLinks()
Method Detail |
---|
public static HTMLScriptCollection GetOpenerJavascript(AActivitySpace _asOwner)
public static final java.lang.String GetOpenerURLCreate(int _nClassID, int _nFolderID, AActivitySpace _asOwner)
_nClassID
- The ClassID of the object to create._nFolderID
- The folder to save the object in._asOwner
- AS to retrieve information from.
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)
_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.
public static final java.lang.String GetOpenerURLCreateExt(int _nClassID, int _nFolderID, java.lang.String _strProvEngName, int _nDataSourceID, int _nWebServiceID, AActivitySpace _asOwner)
_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.
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)
_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.
public static final java.lang.String GetOpenerURLOpenUUID(java.lang.String _strUUID, int _nOpenerMode, AActivitySpace _asOwner)
_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.
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)
_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.
public static final java.lang.String GetOpenerURLOpenObjID(int _nClassID, int _nObjectID, int _nOpenerMode, AActivitySpace _asOwner)
_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.
public static final java.lang.String GetOpenerURLOpenObjID(int _nClassID, int _nObjectID, java.lang.String _strObjectName, int _nOpenerMode, AActivitySpace _asOwner)
_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.
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)
_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.
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)
_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.
public static final java.lang.String GetOpenerURLOpenObjID(int _nClassID, int _nObjectID, java.lang.String _strOptQSArgs, int _nOpenerMode, java.lang.String _strApplicationBaseURL, int _nUserID)
_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.
public static final java.lang.String GetOpenerJSURLOpenAS(java.lang.String _strASName, java.lang.String _strOptQSArgs, java.lang.String _strOpenerMode)
_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.
public static final java.lang.String GetOpenerJSURLOpenAS(java.lang.String _strASName, java.lang.String _strOptQSArgs, int _nOpenerMode)
PTOpenerLinks#GetOpenerJSURLOpenAS(String, String, String, String)
public static final java.lang.String GetOpenerJSURLOpenUUID(java.lang.String _strUUID, java.lang.String _strOptQSArgs, java.lang.String _strOpenerMode)
_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.
public static final java.lang.String GetOpenerJSURLOpenUUID(java.lang.String _strUUID, java.lang.String _strOptQSArgs, int _nOpenerMode)
GetOpenerJSURLOpenUUID(String, String, String)
public static final java.lang.String GetOpenerJSURLOpenObjID(java.lang.String _strClassID, java.lang.String _strObjectID, java.lang.String _strOptQSArgs, java.lang.String _strOpenerMode)
_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.
public static final java.lang.String GetOpenerJSURLOpenObjID(int _nClassID, int _nObjectID, java.lang.String _strOptQSArgs, int _nOpenerMode)
GetOpenerJSURLOpenObjID(String, String, String, String)
public static final java.lang.String GetOpenerJSURL(java.lang.String _strQSArgs, java.lang.String _strOpenerMode)
_strQSArgs
- Arguments to use for opening the object._strOpenerMode
- Mode to open object in, NULL to exclude.
public static final java.lang.String GetOpenerJSURL(java.lang.String _strOptQSArgs, int _nOpenerMode)
GetOpenerJSURL(String, String)
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)
_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.
public static final java.lang.String GetJSOpenInSameWindow(java.lang.String _strURL)
_strURL
- The URL to navigate to.
protected static final boolean useFriendlyURLS(int openerMode, int classId, java.lang.String queryStringArgs)
openerMode
- Opener Mode of the URL to check forclassId
- Class id to the object typequeryStringArgs
- Any additional query string arguments to add
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |