|
Process UI Toolkit API | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.toolkit.utils.VWSessionInfo
This class provides session-related information, such as the document ID, the host name, the name of the library containing the document, the link type (whether the session links to a document or document class), parameter names, the top-level applet, the queue name, and so on. 
Field Summary | |
static int |
TRACKER_MODE_BASED_ON_WOB
|
static int |
TRACKER_MODE_FULL
|
static int |
TRACKER_MODE_READ_ONLY
|
Constructor Summary | |
VWSessionInfo(java.awt.Container parentContainer,
javax.swing.JApplet parentApplet)
Constructs an instance of this VWSessionInfo given a VWSession object, a Container object, and a parent applet. |
|
VWSessionInfo(java.awt.Container parentContainer,
javax.swing.JApplet parentApplet,
VWCommandLineArgs args)
Initializes the object from the given VWCommandLineArgs object -- usually this object is passed to your applet or application class via IVWLaunchableApp.init(). |
|
VWSessionInfo(java.awt.Container parentContainer,
javax.swing.JApplet parentApplet,
filenet.vw.toolkit.utils.VWSession vwSession)
Constructor. |
Method Summary | |
static int |
getCustomWebAppId()
Return the custom web application id |
java.util.Enumeration |
getParameterNames()
Retrieves the names of all parameters. |
javax.swing.JApplet |
getParentApplet()
Retrieves the top level applet. |
java.awt.Container |
getParentContainer()
Retrieves the top level container. |
java.lang.String |
getProperty(java.lang.String keyStr)
Returns the property value for the specified property. |
int |
getRequestedHeight()
Retrieves the height value, in pixels, for client windows. |
int |
getRequestedWidth()
Retrieves the width value, in pixels, for client windows. |
java.lang.String[] |
getRouterIsolatedRegions()
Retrieves an array of defined router isolated regions. |
java.lang.String[] |
getRouterNames()
Retrieves an array of names for all defined routers. |
java.lang.String[] |
getRouterPorts()
Retrieves an array of defined router port numbers. |
java.lang.String[] |
getRouterServiceNames()
Retrieves an array of defined router service names. |
java.lang.String |
getSelectedRouterPath()
Retrieves the router path used to log onto a session. |
filenet.vw.toolkit.utils.VWSession |
getSession()
Gets a VWSession object for the session. |
int |
getTrackerMode()
Retrieves the mode for the Tracker, based on the Work Object number. |
static boolean |
isCustomWebApp()
Return true if the current web application is custom |
static boolean |
isOpenClientWebApp()
Return true if the current web application is Open Client |
boolean |
isShowParticipants()
Determines if any participants are associated with this workflow. |
static boolean |
isWebWorkFloWebApp()
Return true if the current web application is Web WorkFlo |
static boolean |
isWorkPlaceWebApp()
Return true if the current web application is WorkPlace |
void |
logoff()
Logs off the current VWSession. |
void |
setIDMInfo(java.lang.String libraryName,
java.lang.String linkType,
java.lang.String docId)
Sets the relevant Integrated Document Management (IDM) related information. |
void |
setLaunchInfo(java.lang.String wfDocId,
java.lang.String attachDocId,
java.lang.String subject)
Initializes the values necessary to launch a workflow (given the document ID for the workflow definition, the attached document, and the workflow subject). |
void |
setParentContainer(java.awt.Container parentContainer)
Sets the parent container. |
void |
setProperty(java.lang.String keyStr,
java.lang.String valueStr)
Sets the property value |
void |
setRequestedSize(int nWidth,
int nHeight)
Sets the height and width values for the client windows. |
void |
setRuntimeInfo(java.lang.String queueName,
java.lang.String wobNumber)
Sets runtime information for the current session. |
void |
setTrackerMode(int mode)
Sets the Tracker mode flag. |
boolean |
verifyLogon(java.lang.String securityGroupName)
Verifies whether the current user is logged in to a valid session (using the supplied securityGroupName). |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int TRACKER_MODE_BASED_ON_WOB
public static final int TRACKER_MODE_READ_ONLY
public static final int TRACKER_MODE_FULL
Constructor Detail |
public VWSessionInfo(java.awt.Container parentContainer, javax.swing.JApplet parentApplet, filenet.vw.toolkit.utils.VWSession vwSession)
parentContainer
- the parent containerparentApplet
- the parent appletvwSession
- a VWSession objectpublic VWSessionInfo(java.awt.Container parentContainer, javax.swing.JApplet parentApplet)
parentContainer
- A Container object that acts as the parent container
for this object.parentApplet
- A JApplet object that acts as the parent applet.public VWSessionInfo(java.awt.Container parentContainer, javax.swing.JApplet parentApplet, VWCommandLineArgs args)
parentContainer
- A Container object that acts as the parent container for this object.parentApplet
- A JApplet object that acts as the parent applet.args
- VWCommandLingArgs objects containing the command line arguments.Method Detail |
public java.util.Enumeration getParameterNames()
public javax.swing.JApplet getParentApplet()
public java.awt.Container getParentContainer()
public java.lang.String getProperty(java.lang.String keyStr)
keyStr
- A string containing the name of the property for which a
value is needed.public int getRequestedHeight()
public int getRequestedWidth()
public java.lang.String[] getRouterNames()
public java.lang.String[] getRouterPorts()
public java.lang.String[] getRouterServiceNames()
public java.lang.String[] getRouterIsolatedRegions()
public java.lang.String getSelectedRouterPath()
public filenet.vw.toolkit.utils.VWSession getSession()
public int getTrackerMode()
public boolean isShowParticipants()
public void logoff()
public void setIDMInfo(java.lang.String libraryName, java.lang.String linkType, java.lang.String docId)
libraryName
- A string containing the Content Services (CS) library name
that contains the document specified with the docId parameter.linkType
- A string specifying the nature of the link (either a document or a document class).docId
- A string containing the document ID number.public void setLaunchInfo(java.lang.String wfDocId, java.lang.String attachDocId, java.lang.String subject)
wfDocId
- A string containing the document ID for a workflow definition stored in a Content Services (CS) library.attachDocId
- A string containing the document ID for a workflow attachment.subject
- A string containing the text to be used for the subject when the workflow is launched.public void setParentContainer(java.awt.Container parentContainer)
parentContainer
- A Container object to set as the parent.public void setProperty(java.lang.String keyStr, java.lang.String valueStr)
keyStr
- the name of the property to setvalueStr
- the value of the property to setpublic void setRequestedSize(int nWidth, int nHeight)
nWidth
- An integer value that specifies the width, in pixels, for
the client window. The default value is 640.nHeight
- An integer value that specifies the height, in pixels,
for the client window. The default value is 480.public void setRuntimeInfo(java.lang.String queueName, java.lang.String wobNumber)
queueName
- A string containing the name of the workflow queue to be set.wobNumber
- A string containing the Work Object number to be set.public void setTrackerMode(int mode)
mode
- An integer value used to specify the new tracking mode, as follows:
public boolean verifyLogon(java.lang.String securityGroupName)
securityGroupName
- A string containing the group name to use when
attempting to check the logon status for the current user.public static int getCustomWebAppId()
public static boolean isCustomWebApp()
public static boolean isOpenClientWebApp()
public static boolean isWebWorkFloWebApp()
public static boolean isWorkPlaceWebApp()
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |