Process UI Toolkit API

filenet.vw.toolkit.utils
Class VWSessionInfo

java.lang.Object
  extended by filenet.vw.toolkit.utils.VWSessionInfo
All Implemented Interfaces:
java.lang.Cloneable

public class VWSessionInfo
extends java.lang.Object
implements java.lang.Cloneable

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:
eProcess 4.0

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.api.VWSession vwSession)
          Constructor.
VWSessionInfo(java.awt.Container parentContainer, VWCommandLineArgs args, filenet.vw.api.VWSession vwSession)
          Initializes the object from the given VWCommandLineArgs object -- usually this object is passed to your applet or application class via IVWLaunchableApp.init().
VWSessionInfo(VWSessionInfo vwSessionInfo)
          This constructor is similar to a clone method, except that the VWSession is not copied.
 
Method Summary
 java.util.Locale getBrowserLocale()
          Return the browser locale
 boolean getCanSaveToDMS()
          Check to see if we are able to persist to a DMS
 java.lang.String getDiagramStepPaletteName()
           
 boolean getDisplayAdministrationFunctionality()
          Check the system roles for access to the "Administrator" functionality
 boolean getDisplayConfigurationFunctionality()
          Check the system roles for access to the "Configuration Console" functionality
 boolean getDisplayFullBPMFunctionality()
          Determines if the "full" BPM functionality should be displayed
 boolean getDisplayP8BPMFunctionality()
          Determines if the P8 BPM functionality should be displayed
 boolean getDisplayPDExFunctionality()
          Check the system roles for access to the "Process Designer Extended Edition" functionality
 boolean getDisplaySimulationConsoleFunctionality()
          Check the system roles for access to the "Simulation Console" functionality
 boolean getDisplaySimulationDesignerFunctionality()
          Check the system roles for access to the "Simulation Designer" functionality
 java.lang.ClassLoader getExternalClassLoader()
          Retrieves a class loader that can be used to load "external" resources
 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.awt.Container getParentContentPane()
           
 java.awt.Frame getParentFrame()
          Retrieves the top level frame.
 javax.swing.JRootPane getParentRootPane()
           
 java.lang.String getProperty(java.lang.String keyStr)
          Returns the property value for the specified property.
 java.lang.String[] getPublishedStepPaletteNames()
          Retrieves an array of step palette names.
 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 connnection point isolated regions.
 java.lang.String[] getRouterNames()
          Retrieves an array of names for all defined connection points.
 java.lang.String[] getRouterPorts()
          Retrieves an array of defined connnection point port numbers.
 java.lang.String[] getRouterServiceNames()
          Retrieves an array of defined connnection point service names.
 java.lang.String getSecurityGroupName()
           
 java.lang.String getSelectedRouterPath()
          Retrieves the connnection point path used to log onto a session.
 filenet.vw.api.VWSession getSession()
          Gets a VWSession object for the session.
 boolean getShowParticipants()
          Determines if any participants are associated with this workflow.
 java.lang.String[] getSystemRoles()
          Retrieves an array of system role names.
 int getTrackerMode()
          Retrieves the mode for the Tracker, based on the Work Object number.
 boolean isAllowedToRunAdministrationApp()
           
 boolean isAllowedToRunConfigurationApp()
           
 boolean isCustomWebApp()
          Return true if the current web application is custom.
 boolean isP8WebApp(int nWebAppId)
          Check the web application ID
 boolean isWebWorkFloWebApp()
          Return true if the current web application is Web WorkFlo.
 boolean isWorkPlaceWebApp()
          Return true if the current web application is WorkPlace.
 void logoff()
          Logs off the current VWSession.
 void resetVWSession()
          Resets the VWSession instance for cases where we cannot share the 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.
 void updateDefaultWebApplication(filenet.vw.api.VWSession vwSession)
          Set the default web application
 boolean verifyLogon(java.lang.String securityGroupName)
          Verifies whether the current user is logged in to a valid session (using the supplied securityGroupName).
 boolean verifyLogon(java.lang.String[] securityGroupNames, boolean bCheckAll)
          Verifies whether the current user is logged in to a valid session (using the supplied securityGroupName).
 boolean verifyLogonWithoutSessionManagement(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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TRACKER_MODE_BASED_ON_WOB

public static final int TRACKER_MODE_BASED_ON_WOB
See Also:
Constant Field Values

TRACKER_MODE_READ_ONLY

public static final int TRACKER_MODE_READ_ONLY
See Also:
Constant Field Values

TRACKER_MODE_FULL

public static final int TRACKER_MODE_FULL
See Also:
Constant Field Values
Constructor Detail

VWSessionInfo

public VWSessionInfo(java.awt.Container parentContainer,
                     javax.swing.JApplet parentApplet,
                     filenet.vw.api.VWSession vwSession)
Constructor.

Parameters:
parentContainer - the parent container
parentApplet - the parent applet
vwSession - a VWSession object
Since:
eProcess 4.0

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:
eProcess 4.0

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:
eProcess 4.0

VWSessionInfo

public VWSessionInfo(java.awt.Container parentContainer,
                     VWCommandLineArgs args,
                     filenet.vw.api.VWSession vwSession)
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.
args - VWCommandLingArgs objects containing the command line arguments.
vwSession - a VWSession object
Since:
P8 3.0

VWSessionInfo

public VWSessionInfo(VWSessionInfo vwSessionInfo)
This constructor is similar to a clone method, except that the VWSession is not copied.

Parameters:
vwSessionInfo - a VWSessionInfo object
Since:
P8 3.0+
Method Detail

getBrowserLocale

public java.util.Locale getBrowserLocale()
Return the browser locale

Returns:
a Locale object
Since:
P8 4.0

getCanSaveToDMS

public boolean getCanSaveToDMS()
Check to see if we are able to persist to a DMS

Returns:
true if we are able to persist to a DMS
Since:
P8 3.0

getDisplayFullBPMFunctionality

public boolean getDisplayFullBPMFunctionality()
Determines if the "full" BPM functionality should be displayed

Returns:
true if "full" functionality should be supplied
Since:
P8 3.1

getDisplayP8BPMFunctionality

public boolean getDisplayP8BPMFunctionality()
Determines if the P8 BPM functionality should be displayed

Returns:
true if P8 functionality should be supplied
Since:
P8 4.0

getDisplayPDExFunctionality

public boolean getDisplayPDExFunctionality()
Check the system roles for access to the "Process Designer Extended Edition" functionality

Returns:
true if the extended functionality should be displayed
Since:
P8 4.0.1

getDisplaySimulationDesignerFunctionality

public boolean getDisplaySimulationDesignerFunctionality()
Check the system roles for access to the "Simulation Designer" functionality

Returns:
true if the extended functionality should be displayed
Since:
P8 4.5.0

getDisplaySimulationConsoleFunctionality

public boolean getDisplaySimulationConsoleFunctionality()
Check the system roles for access to the "Simulation Console" functionality

Returns:
true if the extended functionality should be displayed
Since:
P8 4.5.0

getDisplayAdministrationFunctionality

public boolean getDisplayAdministrationFunctionality()
Check the system roles for access to the "Administrator" functionality

Returns:
true if the extended functionality should be displayed
Since:
P8 4.5.0

isAllowedToRunAdministrationApp

public boolean isAllowedToRunAdministrationApp()
Returns:
true if the current user is allowed to run the Administrator application
Since:
P8 4.5.0

getDisplayConfigurationFunctionality

public boolean getDisplayConfigurationFunctionality()
Check the system roles for access to the "Configuration Console" functionality

Returns:
true if the extended functionality should be displayed
Since:
P8 4.5.0

isAllowedToRunConfigurationApp

public boolean isAllowedToRunConfigurationApp()
Returns:
true if the current user is allowed to run the Configuration Console application
Since:
P8 4.5.0

getExternalClassLoader

public java.lang.ClassLoader getExternalClassLoader()
Retrieves a class loader that can be used to load "external" resources

Returns:
a class loader that can be used to load "external" resources
Since:
P8 3.0

getParameterNames

public java.util.Enumeration getParameterNames()
Retrieves the names of all parameters.

Returns:
An Enumeration object that contains the parameter names.
Since:
eProcess 4.2

getParentApplet

public javax.swing.JApplet getParentApplet()
Retrieves the top level applet.

Returns:
A JApplet object that represents (or contains) the top-level applet.
Since:
eProcess 4.0

getParentContainer

public java.awt.Container getParentContainer()
Retrieves the top level container.

Returns:
A Container object that represents the top-level container.
Since:
eProcess 4.0

getParentFrame

public java.awt.Frame getParentFrame()
Retrieves the top level frame.

Returns:
A Frame object that represents the top-level container.
Since:
P8 4.0.3

getParentRootPane

public javax.swing.JRootPane getParentRootPane()
Returns:
the application's root pane
Since:
P8 4.5.0

getParentContentPane

public java.awt.Container getParentContentPane()
Returns:
the application's content pane
Since:
P8 4.5.0

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:
eProcess 4.2

getPublishedStepPaletteNames

public java.lang.String[] getPublishedStepPaletteNames()
Retrieves an array of step palette names.

Returns:
An array of step palette names. Each string in the array contains the full package name of the step palette file.
Since:
P8 3.0

getDiagramStepPaletteName

public java.lang.String getDiagramStepPaletteName()
Returns:
the diagram step palette name
Since:
P8 4.5.0

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:
eProcess 4.0

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:
eProcess 4.0

getRouterNames

public java.lang.String[] getRouterNames()
Retrieves an array of names for all defined connection points.

Returns:
An array of names. Each string in the array contains a valid connnection point name.
Since:
eProcess 4.2

getRouterPorts

public java.lang.String[] getRouterPorts()
Retrieves an array of defined connnection point port numbers.

Returns:
An array of port numbers. Each string in the array contains a valid connnection point port number.
Since:
eProcess 4.2

getRouterServiceNames

public java.lang.String[] getRouterServiceNames()
Retrieves an array of defined connnection point service names.

Returns:
An array of service names. Each string in the array contains a valid connnection point service name.
Since:
P8 2.0

getRouterIsolatedRegions

public java.lang.String[] getRouterIsolatedRegions()
Retrieves an array of defined connnection point isolated regions.

Returns:
An array of isolated regions. Each string in the array contains a valid connnection point isolated region.
Since:
P8 2.0

getSelectedRouterPath

public java.lang.String getSelectedRouterPath()
Retrieves the connnection point path used to log onto a session.

Returns:
A string containing the name of the log on path selected to access the connnection point.
Since:
eProcess 4.0

getSession

public filenet.vw.api.VWSession getSession()
Gets a VWSession object for the session.

Returns:
A VWSession object that contains all information for this session.
Since:
eProcess 4.0

resetVWSession

public void resetVWSession()
Resets the VWSession instance for cases where we cannot share the VWSession

Since:
P8 4.0

getShowParticipants

public boolean getShowParticipants()
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:
eProcess 4.0

getSystemRoles

public java.lang.String[] getSystemRoles()
Retrieves an array of system role names.

Returns:
An array of names. Each string in the array contains a system role the user is a member of.
Since:
P8 3.0

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:
eProcess 4.0

isCustomWebApp

public boolean isCustomWebApp()
Return true if the current web application is custom.

Returns:
true if the current web application is custom.
Since:
eProcess 5.0

isWebWorkFloWebApp

public boolean isWebWorkFloWebApp()
Return true if the current web application is Web WorkFlo.

Returns:
true if the current web application is Web WorkFlo.
Since:
eProcess 5.0

isWorkPlaceWebApp

public boolean isWorkPlaceWebApp()
Return true if the current web application is WorkPlace.

Returns:
true if the current web application is WorkPlace.
Since:
eProcess 5.0

updateDefaultWebApplication

public void updateDefaultWebApplication(filenet.vw.api.VWSession vwSession)
Set the default web application

Parameters:
vwSession -
Since:
P8 4.0.1

isP8WebApp

public boolean isP8WebApp(int nWebAppId)
Check the web application ID

Parameters:
nWebAppId -
Returns:
true if the webAppId is for a P8 web application
Since:
P8 4.0.1
See Also:
VWSession

logoff

public void logoff()
Logs off the current VWSession.

Since:
eProcess 4.0

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:
eProcess 4.0

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:
eProcess 4.0

setParentContainer

public void setParentContainer(java.awt.Container parentContainer)
Sets the parent container.

Parameters:
parentContainer - A Container object to set as the parent.
Since:
eProcess 4.0

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:
eProcess 4.2

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:
eProcess 4.0

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:
eProcess 4.0

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:
eProcess 4.0

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:
eProcess 4.0

verifyLogon

public boolean verifyLogon(java.lang.String[] securityGroupNames,
                           boolean bCheckAll)
Verifies whether the current user is logged in to a valid session (using the supplied securityGroupName).

Parameters:
securityGroupNames - A string array containing the group names to use when attempting to check the logon status for the current user.
bCheckAll - a place holder
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:
P8 4.5.0

verifyLogonWithoutSessionManagement

public boolean verifyLogonWithoutSessionManagement(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:
eProcess 4.0

getSecurityGroupName

public java.lang.String getSecurityGroupName()
Returns:
the current security group name
Since:
P8 4.5.0

Process UI Toolkit API

© Copyright IBM Corporation 2002, 2008. All rights reserved.