Process UI Toolkit API

filenet.vw.toolkit.utils
Class VWSessionInfo

java.lang.Object
  |
  +--filenet.vw.toolkit.utils.VWSessionInfo

public class VWSessionInfo
extends java.lang.Object

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. 

Since:
IWWS1.00

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

TRACKER_MODE_BASED_ON_WOB

public static final int TRACKER_MODE_BASED_ON_WOB

TRACKER_MODE_READ_ONLY

public static final int TRACKER_MODE_READ_ONLY

TRACKER_MODE_FULL

public static final int TRACKER_MODE_FULL
Constructor Detail

VWSessionInfo

public VWSessionInfo(java.awt.Container parentContainer,
                     javax.swing.JApplet parentApplet,
                     filenet.vw.toolkit.utils.VWSession vwSession)
Constructor.
Parameters:
parentContainer - the parent container
parentApplet - the parent applet
vwSession - a VWSession object
Since:
IWWS1.00

VWSessionInfo

public 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. Use this method when creating an instance of this class from an application.
Parameters:
parentContainer - A Container object that acts as the parent container for this object.
parentApplet - A JApplet object that acts as the parent applet.
Since:
IWWS1.00

VWSessionInfo

public 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().
Parameters:
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.
Since:
IWWS1.00
Method Detail

getParameterNames

public java.util.Enumeration getParameterNames()
Retrieves the names of all parameters.
Returns:
An Enumeration object that contains the parameter names.
Since:
IWWS1.10

getParentApplet

public javax.swing.JApplet getParentApplet()
Retrieves the top level applet.
Returns:
A JApplet object that represents (or contains) the top-level applet.
Since:
IWWS1.00

getParentContainer

public java.awt.Container getParentContainer()
Retrieves the top level container.
Returns:
A Container object that represents the top-level container.
Since:
IWWS1.00

getProperty

public java.lang.String getProperty(java.lang.String keyStr)
Returns the property value for the specified property.
Parameters:
keyStr - A string containing the name of the property for which a value is needed.
Returns:
A string containing the property value for the property specified in the keyStr parameter.
Since:
IWWS1.10

getRequestedHeight

public int getRequestedHeight()
Retrieves the height value, in pixels, for client windows. The default value is 480.
Returns:
An unsigned integer value that represents the pixel height value used for client windows.
Since:
IWWS1.00

getRequestedWidth

public int getRequestedWidth()
Retrieves the width value, in pixels, for client windows. The default value is 640.
Returns:
An unsigned integer value that represents a pixel width value used for client windows.
Since:
IWWS1.00

getRouterNames

public java.lang.String[] getRouterNames()
Retrieves an array of names for all defined routers.
Returns:
An array of names. Each string in the array contains a valid router name.
Since:
IWWS1.10

getRouterPorts

public java.lang.String[] getRouterPorts()
Retrieves an array of defined router port numbers.
Returns:
An array of port numbers. Each string in the array contains a valid router port number.
Since:
IWWS1.10

getRouterServiceNames

public java.lang.String[] getRouterServiceNames()
Retrieves an array of defined router service names.
Returns:
An array of service names. Each string in the array contains a valid router service name.
Since:
2.0

getRouterIsolatedRegions

public java.lang.String[] getRouterIsolatedRegions()
Retrieves an array of defined router isolated regions.
Returns:
An array of isolated regions. Each string in the array contains a valid router isolated region.
Since:
2.0

getSelectedRouterPath

public java.lang.String getSelectedRouterPath()
Retrieves the router path used to log onto a session.
Returns:
A string containing the name of the log on path selected to access the router.
Since:
IWWS1.00

getSession

public filenet.vw.toolkit.utils.VWSession getSession()
Gets a VWSession object for the session.
Returns:
A VWSession object that contains all information for this session.
Since:
IWWS1.00

getTrackerMode

public int getTrackerMode()
Retrieves the mode for the Tracker, based on the Work Object number.
Returns:
An integer flag (which may be 0, 1, or 2) indicating the Tracker mode, as follows:

  • 0: Tracking is based on the Work Object number
  • 1: Tracking is read-only
  • 2: Tracking is read-only and full access
Since:
IWWS1.00

isShowParticipants

public boolean isShowParticipants()
Determines if any participants are associated with this workflow.
Returns:
A Boolean value. The method returns TRUE if participants are associated with the workflow; otherwise, the method returns FALSE.
Since:
IWWS1.00

logoff

public void logoff()
Logs off the current VWSession.
Since:
IWWS1.00

setIDMInfo

public void setIDMInfo(java.lang.String libraryName,
                       java.lang.String linkType,
                       java.lang.String docId)
Sets the relevant Integrated Document Management (IDM) related information.
Parameters:
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.
Since:
IWWS 1.00

setLaunchInfo

public 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).
Parameters:
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.
Since:
IWWS 1.00

setParentContainer

public void setParentContainer(java.awt.Container parentContainer)
Sets the parent container.
Parameters:
parentContainer - A Container object to set as the parent.
Since:
IWWS1.00

setProperty

public void setProperty(java.lang.String keyStr,
                        java.lang.String valueStr)
Sets the property value
Parameters:
keyStr - the name of the property to set
valueStr - the value of the property to set
Since:
IWWS1.10

setRequestedSize

public void setRequestedSize(int nWidth,
                             int nHeight)
Sets the height and width values for the client windows.
Parameters:
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.
Since:
IWWS 1.00

setRuntimeInfo

public void setRuntimeInfo(java.lang.String queueName,
                           java.lang.String wobNumber)
Sets runtime information for the current session.
Parameters:
queueName - A string containing the name of the workflow queue to be set.
wobNumber - A string containing the Work Object number to be set.
Since:
IWWS 1.00

setTrackerMode

public void setTrackerMode(int mode)
Sets the Tracker mode flag. The default tracking is based on the Work Object number.
Parameters:
mode - An integer value used to specify the new tracking mode, as follows:

  • TRACKER_MODE_BASED_ON_WOB: Tracking is based on the Work Object number
  • TRACKER_MODE_READ_ONLY: Tracking is read-only
  • TRACKER_MODE_FULL: Tracking is read-only and full access
Since:
IWWS 1.00

verifyLogon

public boolean verifyLogon(java.lang.String securityGroupName)
Verifies whether the current user is logged in to a valid session (using the supplied securityGroupName).
Parameters:
securityGroupName - A string containing the group name to use when attempting to check the logon status for the current user.
Returns:
A boolean value; the method returns TRUE only if the specified user belongs to the group name and the user is logged in to a valid session; otherwise, the method returns FALSE.
Since:
IWWS1.00

getCustomWebAppId

public static int getCustomWebAppId()
Return the custom web application id
Returns:
the custom web application id
Since:
5.0

isCustomWebApp

public static boolean isCustomWebApp()
Return true if the current web application is custom
Returns:
true if the current web application is custom
Since:
5.0

isOpenClientWebApp

public static boolean isOpenClientWebApp()
Return true if the current web application is Open Client
Returns:
true if the current web application is Open Client
Since:
5.0

isWebWorkFloWebApp

public static boolean isWebWorkFloWebApp()
Return true if the current web application is Web WorkFlo
Returns:
true if the current web application is Web WorkFlo
Since:
5.0

isWorkPlaceWebApp

public static boolean isWorkPlaceWebApp()
Return true if the current web application is WorkPlace
Returns:
true if the current web application is WorkPlace
Since:
5.0


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.