|
Process UI Toolkit API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.toolkit.utils.VWSessionInfo
public class 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.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 |
---|
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.api.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.public VWSessionInfo(java.awt.Container parentContainer, VWCommandLineArgs args, filenet.vw.api.VWSession vwSession)
parentContainer
- A Container object that acts as the parent container for this object.args
- VWCommandLingArgs objects containing the command line arguments.vwSession
- a VWSession objectpublic VWSessionInfo(VWSessionInfo vwSessionInfo)
vwSessionInfo
- a VWSessionInfo objectMethod Detail |
---|
public java.util.Locale getBrowserLocale()
public boolean getCanSaveToDMS()
public boolean getDisplayFullBPMFunctionality()
public boolean getDisplayP8BPMFunctionality()
public boolean getDisplayPDExFunctionality()
public boolean getDisplaySimulationDesignerFunctionality()
public boolean getDisplaySimulationConsoleFunctionality()
public boolean getDisplayAdministrationFunctionality()
public boolean isAllowedToRunAdministrationApp()
public boolean getDisplayConfigurationFunctionality()
public boolean isAllowedToRunConfigurationApp()
public java.lang.ClassLoader getExternalClassLoader()
public java.util.Enumeration getParameterNames()
public javax.swing.JApplet getParentApplet()
public java.awt.Container getParentContainer()
public java.awt.Frame getParentFrame()
public javax.swing.JRootPane getParentRootPane()
public java.awt.Container getParentContentPane()
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 java.lang.String[] getPublishedStepPaletteNames()
public java.lang.String getDiagramStepPaletteName()
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.api.VWSession getSession()
public void resetVWSession()
public boolean getShowParticipants()
public java.lang.String[] getSystemRoles()
public int getTrackerMode()
public boolean isCustomWebApp()
public boolean isWebWorkFloWebApp()
public boolean isWorkPlaceWebApp()
public void updateDefaultWebApplication(filenet.vw.api.VWSession vwSession)
vwSession
- public boolean isP8WebApp(int nWebAppId)
nWebAppId
-
VWSession
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 boolean verifyLogon(java.lang.String[] securityGroupNames, boolean bCheckAll)
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
public boolean verifyLogonWithoutSessionManagement(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 java.lang.String getSecurityGroupName()
|
Process UI Toolkit API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |