SessionUtils (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.util.SessionUtils

```
public class SessionUtils
extends java.lang.Object
```
This class provides implementation for SESSION attributes and methods. Mainly, the APIs implemented here are defined in the CommonSession interface (or one of its super interfaces) and are not statically implemented by the classes used by the asHandle().

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class SessionUtils.WorkArea
Stores global data relating to the state of the current context.

Nested Classes
Modifier and Type	Class and Description
`private static class`	`SessionUtils.WorkArea` Stores global data relating to the state of the current context.

Field Summary

Fields
Modifier and Type	Field and Description
`private static java.lang.Object`	`DEVICE_ID_LOCK` Lock for synchronizing device id writes.
`private static CentralLogger`	`LOG` Logger
`private static ContextLocal<StartupParameters>`	`startupParameters` Context local proxy that allows the startup parameters to be pushed from server to client.
`private static ContextLocal<SessionUtils.WorkArea>`	`work` Context local proxy that allows SESSION attributes to be pushed from server to client.

Constructor Summary

Constructors
Constructor and Description

SessionUtils()

Constructors
Constructor and Description
`SessionUtils()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`_isRemote()` Indicates if the session is for the context of an appserver.
`static StartupParameters`	`_startupParameters()` Get the startup parameters.
`static handle`	`asHandle()` Get a the instance for the SESSION system handle.
`(package private) static void`	`clientDisconnected()` Mark this context as the client has disconnected (due to an abend, socket disconnect, etc).
`static object<? extends OerequestInfo>`	`currentRequestInfo()` Get the CURRENT-REQUEST-INFO attribute of this session.
`static object<? extends OerequestInfo>`	`currentResponseInfo()` Get the CURRENT-RESPONSE-INFO attribute of this session.
`static logical`	`export(character procList)` Method that specifies the remote procedures the client can execute from the AppServer session.
`static logical`	`export(java.lang.String procList)` Method that specifies the remote procedures the client can execute from the AppServer session.
`static handle`	`firstBuffer()` Returns the handle for the first dynamic buffer in the first table containing a dynamic buffer.
`static handle`	`firstChild()` Returns the handle for the first window in the session.
`static object<?>`	`firstObject()` Get the FIRST-OBJECT attribute of this session.
`static handle`	`firstQuery()` Returns the handle for the first created dynamic query.
`static handle`	`firstServer()` Get the FIRST-SERVER attribute of this session.
`static handle`	`firstServerSocket()` Get the FIRST-SERVER-SOCKET attribute of this session.
`static handle`	`firstSocket()` Get the FIRST-SOCKET attribute of this session.
`static void`	`forkNewSession(character cfgOverrides, character authBlob)` Starts a new forked session.
`static void`	`forkNewSession(character cfgOverrides, java.lang.String authBlob)` Starts a new forked session.
`static void`	`forkNewSession(java.lang.String cfgOverrides, character authBlob)` Starts a new forked session.
`static void`	`forkNewSession(java.lang.String cfgOverrides, java.lang.String authBlob)` Starts a new forked session.
`static character`	`getAuthBlob()` Returns the authentication blob content.
`static character`	`getBrowserExternalIp()` Returns the external IP of the end-user machine, where the js client runs.
`static integer`	`getBrowserPort()` Returns the TCP port of the end-user machine, on which the WebSocket runs in the browser.
`static integer`	`getBrowserTimezone()` Returns the offset in minutes from UTC for the browser timezone.
`static character`	`getClientExternalIp()` Returns the external IP of the client machine.
`static datetime`	`getClientIpCaptureTime()` Returns the UTC datetime of the capture time for CLIENT-EXTERNAL-IP.
`static integer`	`getClientPort()` Returns the TCP port of the client machine.
`static integer`	`getClientTimezone()` Returns the offset in minutes from UTC for the client machine timezone.
`static character`	`getClientType()` This is a helper method returning the value of OEClientType for the session's OeversionInfo.
`static ClientType[]`	`getClientTypes()` This is a helper method returning the value of OEClientType for the session's OeversionInfo.
`static character`	`getContextHelpFile()` Get the CONTEXT-HELP-FILE attribute of this session.
`static character`	`getDateFormat()` Gets the order of date components (SESSION:DATE-FORMAT) for conversion to/from strings.
`static character`	`getDeviceId()` Returns the device ID.
`static long`	`getExitCode()` Get the value of SESSION:EXIT-CODE attribute.
`static handle`	`getFirstDataSet()` Obtain a handle to the first dynamic `DataSet` object created in the current session.
`static handle`	`getFirstDataSource()` Obtain a handle to the first dynamic `DataSource` object created in the current session.
`static character`	`getICFParameter()` Get the ICFPARAMETER attribute of this session.
`static datetime`	`getIpCaptureTime()` Returns the UTC datetime of the capture time for BROWSER-EXTERNAL-IP.
`static character`	`getLoginParam(character paramName)` Returns the first value of the login parameter.
`static character`	`getLoginParam(character paramName, int oeIndex)` Returns the index value of the login parameter.
`static character`	`getLoginParam(character paramName, integer oeIndex)` Returns the index value of the login parameter.
`static character`	`getLoginParam(java.lang.String paramName)` Returns the first value of the login parameter.
`static character`	`getLoginParam(java.lang.String paramName, int oeIndex)` Returns the index value of the login parameter.
`static character`	`getLoginParam(java.lang.String paramName, integer oeIndex)` Returns the index value of the login parameter.
`static java.util.Map<java.lang.String,java.lang.String[]>`	`getLoginParams()` Returns all login parameters.
`static integer`	`getMultitaskingInterval()` Get the value of SESSION:MULTITASKING-INTERVAL attribute.
`static character`	`getParameter()` Get the value of the PARAMETER attribute, which is set to the value of the 4GL `-param` command line option specified for the current session.
`static integer`	`getPixelsPerColumn()` Get the PIXELS-PER-COLUMN attribute of this session.
`static integer`	`getPixelsPerRow()` Get the PIXELS-PER-ROW attribute of this session.
`static integer`	`getPrinterControlHandle()` Get the state of SESSION:PRINTER-CONTROL-HANDLE attribute.
`static integer`	`getPrinterHDC()` Get the state of SESSION:PRINTER-HDC attribute.
`static character`	`getPrinterName()` Get the state of SESSION:PRINTER-NAME attribute.
`static character`	`getPrinterPort()` Get the state of SESSION:PRINTER-PORT attribute.
`static character`	`getPrinters()` The SESSION:GET-PRINTERS method.
`static character`	`getRelatedSessionId()` Returns the unique ID of the original session that was forked.
`static integer`	`getScreenColorDepth()` Returns the client screen color depth.
`static integer`	`getScreenHeight()` Returns the client screen height.
`static decimal`	`getScreenScalingFactor()` Returns the client screen scaling factor.
`static integer`	`getScreenWidth()` Returns the client screen width.
`static logical`	`getServerConnectionBoundRequest()` Get the SERVER-CONNECTION-BOUND-REQUEST attribute of this session.
`static character`	`getServerConnectionContext()` Get the SERVER-CONNECTION-CONTEXT attribute of this session.
`static character`	`getServerConnectionId()` Get the value of SESSION:SERVER-CONNECTION-ID attribute.
`static character`	`getServerOperatingMode()` Method implementation for getting the SERVER-OPERATING-MODE attribute of the session handle.
`static integer`	`getSessionDisplayTimeZone()` Obtains the currently configured DISPLAY-TIMEZONE attribute for the current user's context.
`static character`	`getSessionId()` Returns the session unique identifier.
`static character`	`getSessionTimeSource()` Obtains the currently configured TIME-SOURCE attribute for the current user's context.
`static integer`	`getSessionTimeZone()` Accesses the SESSION:TIMEZONE used as the default offset in minutes from UTC for this user's context.
`static logical`	`getSessionTooltips()` Accesses the SESSION:TOOLTIPS attribute for this session.
`static character`	`getStartupParameters()` Get the state of SESSION:STARTUP-PARAMETERS attribute.
`static java.lang.String`	`getStorageId()` Getter for the storage ID of the end-user (available with SSO).
`static character`	`getSuppressWarningsList()` Get the SUPPRESS-WARNINGS-LIST of this session.
`static character`	`getTerminationHook()` Get the TERMINATION-HOOK attribute of this session.
`static character`	`getUserAgent()` Returns the user agent info of the browser where the js client runs.
`static logical`	`getWebUploadError()` Returns {code true} when the current direct upload operation ended with an error, `false` otherwise.
`static character`	`getWebUploadFiles()` Returns comma delimited string of local file system paths of the files uploaded during direct upload or a comma delimited string of file names chosen during direct file upload.
`static integer`	`getYearOffset()` Implementation of SESSION:YEAR-OFFSET attribute getter.
`static java.lang.Long`	`id()` Get this resource's ID.
`static void`	`id(long id)` Set this resource's ID.
`static logical`	`is3D()` Get THREE-D attribute value for SESSION handle.
`static logical`	`isClientDisconnected()` Get the CLIENT-DISCONNECTED attribute of this session.
`static logical`	`isDataEntryReturn()` Get the state of SESSION:DATA-ENTRY-RETURN attribute.
`static logical`	`isDebugAlert()` Get the state of SESSION:DEBUG-ALERT attribute.
`static logical`	`isErrorStackTrace()` Get the ERROR-STACK-TRACE attribute of this session.
`static logical`	`isRemote()` Indicates if the session is for the context of an appserver.
`static logical`	`isServerConnectionBound()` Get the SERVER-CONNECTION-BOUND attribute of this session.
`static logical`	`isSuppressWarnings()` Get the state of SESSION:SUPPRESS-WARNINGS attribute.
`static logical`	`isSystemAlertBoxes()` Get the state of SESSION:SYSTEM-ALERT-BOXES attribute.
`static handle`	`lastChild()` Returns the handle for the last window in the session.
`static object<?>`	`lastObject()` Get the LAST-OBJECT attribute of this session.
`static handle`	`lastServer()` Get the LAST-SERVER attribute of this session.
`static handle`	`lastServerSocket()` Get the LAST-SERVER-SOCKET attribute of this session.
`static handle`	`lastSocket()` Get the LAST-SOCKET attribute of this session.
`static logical`	`loadIcon(character iconName)` Set the state of SESSION:LOAD-ICON attribute.
`static logical`	`loadIcon(java.lang.String iconName)` Set the state of SESSION:LOAD-ICON attribute.
`static object<? extends OeversionInfo>`	`localVersionInfo()` Get the LOCAL-VERSION-INFO attribute of this session.
`static void`	`readOnlyError(java.lang.String attribute)` API needed to implement read-only attribute assignment (a 4GL "feature").
`static void`	`readOnlyError(java.lang.String attribute, java.lang.Object expr)` Emitted and to be used only in cases the attribute is read-only.
`static character`	`resourceType()` Get the type of its associated handle.
`static void`	`set3D(logical value)` Set THREE-D attribute value for SESSION handle.
`static void`	`setAuthBlob(java.lang.String authBlob)` Sets the authentication blob content.
`static void`	`setBrowserExternalIp(java.lang.String browserExternalIp)` Setter for the external IP of the end-user machine, where the js client runs.
`static void`	`setBrowserPort(int browserPort)` Setter for the TCP port of the end-user machine, on which the WebSocket runs in the browser.
`static void`	`setBrowserTimezone(int browserTimezone)` Setter for the offset in minutes from UTC for the browser timezone.
`static void`	`setClientExternalIp(java.lang.String clientExternalIp)` Setter for the external IP of the client machine.
`static void`	`setClientIpCaptureTime(long ipCaptureTimestamp)` Setter for the datetime of the capture time for CLIENT-EXTERNAL-IP.
`static void`	`setClientPort(int clientPort)` Setter for the TCP port of the client machine.
`static void`	`setClientTimezone(int clientTimezone)` Setter for the offset in minutes from UTC for the client machine timezone.
`static void`	`setClientTypes(ClientType... clientTypes)` This is a helper method setting the value of OEClientType for the session's OeversionInfo.
`static void`	`setContextHelpFile(character file)` Set the CONTEXT-HELP-FILE attribute of this session.
`static void`	`setContextHelpFile(java.lang.String file)` Set the CONTEXT-HELP-FILE attribute of this session.
`static void`	`setDataEntryReturn(boolean on)` Set the state of SESSION:DATA-ENTRY-RETURN attribute.
`static void`	`setDataEntryReturn(logical on)` Set the state of SESSION:DATA-ENTRY-RETURN attribute.
`static void`	`setDateFormat(character dateFormat)` Sets the order of date components (SESSION:DATE-FORMAT) for conversion to/from strings.
`static void`	`setDateFormat(java.lang.String dateFormat)` Sets the order of date components (SESSION:DATE-FORMAT) for conversion to/from strings.
`static void`	`setDebugAlert(boolean on)` Set the state of SESSION:DEBUG-ALERT attribute.
`static void`	`setDebugAlert(logical on)` Set the state of SESSION:DEBUG-ALERT attribute.
`static void`	`setDeviceId(java.lang.String deviceId)` Sets the device ID.
`static void`	`setErrorStackTrace(boolean state)` Set the ERROR-STACK-TRACE attribute of this session.
`static void`	`setErrorStackTrace(logical state)` Set the ERROR-STACK-TRACE attribute of this session.
`static void`	`setExitCode(long value)` Set the value of SESSION:EXIT-CODE attribute.
`static void`	`setIpCaptureTime(long ipCaptureTimestamp)` Setter for the datetime of the capture time for BROWSER-EXTERNAL-IP.
`static void`	`setLoginParams(java.util.Map<java.lang.String,java.lang.String[]> loginParams)` Sets the params sent by the login request.
`static void`	`setMultitaskingInterval(NumberType interval)` Set the value of SESSION:MULTITASKING-INTERVAL attribute.
`static void`	`setPrinterControlHandle(integer value)` Set the state of SESSION:PRINTER-CONTROL-HANDLE attribute.
`static void`	`setPrinterName(character value)` Set the state of SESSION:PRINTER-NAME attribute.
`static void`	`setPrinterPort(character value)` Set the state of SESSION:PRINTER-PORT attribute.
`static void`	`setRelatedSessionId(java.lang.String relatedSessionId)` Sets the RELATED-SESSION-ID attribute.
`static void`	`setScreenColorDepth(int screenColorDepth)` Setter for the client screen color depth.
`static void`	`setScreenHeight(int screenHeight)` Setter for the client screen height.
`static void`	`setScreenScalingFactor(float screenScalingFactor)` Setter for the client screen scaling factor.
`static void`	`setScreenWidth(int screenWidth)` Setter for the client screen width.
`static void`	`setServerConnectionBoundRequest(boolean state)` Set the SERVER-CONNECTION-BOUND-REQUEST attribute of this session.
`static void`	`setServerConnectionBoundRequest(logical state)` Set the SERVER-CONNECTION-BOUND-REQUEST attribute of this session.
`static void`	`setServerConnectionContext(character val)` Set the SERVER-CONNECTION-CONTEXT attribute of this session.
`static void`	`setServerConnectionContext(java.lang.String val)` Set the SERVER-CONNECTION-CONTEXT attribute of this session.
`static void`	`setSessionDisplayTimeZone(NumberType displayTimezone)` Sets the `DISPLAY-TIMEZONE` attribute for the user's context.
`static void`	`setSessionId(character sessionId)` Set the SESSION-ID Attribute.
`static void`	`setSessionId(java.lang.String sessionId)` Set the SESSION-ID Attribute.
`static void`	`setSessionTimeSource(character timeSource)` Sets the `TIME-SOURCE` attribute for the user's context.
`static void`	`setSessionTimeZone(NumberType offset)` Sets the SESSION:TIMEZONE used as the default offset in minutes from UTC for this user's context.
`static void`	`setSessionTooltips(logical tooltips)` Sets the SESSION:TOOLTIPS attribute for this session.
`static void`	`setStartupParameters(StartupParameters startupParameters)` Sets the startup parameters.
`static void`	`setStorageId(java.lang.String storageId)` Setter for the storage ID of the end-user (available with SSO).
`static void`	`setSuppressWarnings(boolean value)` Set the state of SESSION:SUPPRESS-WARNINGS attribute.
`static void`	`setSuppressWarnings(logical value)` Set the state of SESSION:SUPPRESS-WARNINGS attribute.
`static void`	`setSuppressWarningsList(java.lang.String list)` Set the SUPPRESS-WARNINGS-LIST attribute of this session.
`static void`	`setSuppressWarningsList(Text list)` Set the SUPPRESS-WARNINGS-LIST attribute of this session.
`static void`	`setSystemAlertBoxes(boolean on)` Set the state of SESSION:SYSTEM-ALERT-BOXES attribute.
`static void`	`setSystemAlertBoxes(logical on)` Set the state of SESSION:SYSTEM-ALERT-BOXES attribute.
`static void`	`setTerminationHook(character hook)` Set the TERMINATION-HOOK attribute of this session.
`static void`	`setTerminationHook(java.lang.String hook)` Set the TERMINATION-HOOK attribute of this session.
`static void`	`setUserAgent(java.lang.String userAgent)` Setter for the user agent info of the browser where the js client runs.
`static void`	`setWebUploadInfo(java.lang.String[] uploadFiles, boolean error)` Assigns the upload information related to the current direct upload.
`static void`	`setYearOffset(NumberType year)` Implementation of SESSION:YEAR-OFFSET attribute setter.
`static boolean`	`unknown()` Implementation for the `WrappedResource.unknown()` API.
`static boolean`	`valid()` Implementation for the `WrappedResource.valid()` API.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LOG
```
private static final CentralLogger LOG
```
    Logger
  - work
```
private static final ContextLocal<SessionUtils.WorkArea> work
```
    Context local proxy that allows SESSION attributes to be pushed from server to client.
  - DEVICE_ID_LOCK
```
private static final java.lang.Object DEVICE_ID_LOCK
```
    Lock for synchronizing device id writes.
  - startupParameters
```
private static final ContextLocal<StartupParameters> startupParameters
```
    Context local proxy that allows the startup parameters to be pushed from server to client.
- Constructor Detail
  - SessionUtils
```
public SessionUtils()
```
- Method Detail
  - asHandle
```
public static handle asHandle()
```
    Get a the instance for the SESSION system handle. Is obtained using a call to the StaticProxy.obtain(Class, Class[]), using the CommonSession interface and its methods implemented by these classes: SessionUtils, EnvironmentOps, date, LogicalTerminal, ProcedureManager.
    
    Returns:
    
    See above.
  - getSessionId
```
public static character getSessionId()
```
    Returns the session unique identifier.
    
    Returns:
    
    The session unique identifier.
  - setSessionId
```
public static void setSessionId(character sessionId)
```
    Set the SESSION-ID Attribute.
    
    Parameters:
    
    sessionId - The value of the SESSION-ID attribute.
  - setSessionId
```
public static void setSessionId(java.lang.String sessionId)
```
    Set the SESSION-ID Attribute.
    
    Parameters:
    
    sessionId - The value of the SESSION-ID attribute.
  - getAuthBlob
```
public static character getAuthBlob()
```
    Returns the authentication blob content.
    
    Returns:
    
    The authentication blob content.
  - getDeviceId
```
public static character getDeviceId()
```
    Returns the device ID.
    
    Returns:
    
    The device ID.
  - setAuthBlob
```
public static void setAuthBlob(java.lang.String authBlob)
```
    Sets the authentication blob content.
    
    Parameters:
    
    authBlob - The authentication blob content.
  - setDeviceId
```
public static void setDeviceId(java.lang.String deviceId)
```
    Sets the device ID. It can be set only once in the lifespan of the session.
    
    Parameters:
    
    deviceId - The device ID.
  - getRelatedSessionId
```
public static character getRelatedSessionId()
```
    Returns the unique ID of the original session that was forked. Corresponds with the SESSION:RELATED-SESSION-ID system handle attribute.
    
    Returns:
    
    The unique ID of the original session that was forked.
  - setRelatedSessionId
```
public static void setRelatedSessionId(java.lang.String relatedSessionId)
```
    Sets the RELATED-SESSION-ID attribute. Setter can't be accessed in 4GL.
    
    Parameters:
    
    relatedSessionId - The unique ID of the original session that was forked.
  - forkNewSession
```
public static void forkNewSession(character cfgOverrides,
                                  character authBlob)
```
    Starts a new forked session. Corresponds with the SESSION:NEW-SESSION(character, character) system handle method.
    
    Parameters:
    
    cfgOverrides - New session startup parameters.
    
    authBlob - The value to be assigned to SESSION:AUTH-BLOB in the new session.
  - forkNewSession
```
public static void forkNewSession(java.lang.String cfgOverrides,
                                  character authBlob)
```
    Starts a new forked session. Corresponds with the SESSION:NEW-SESSION(String, character) system handle method.
    
    Parameters:
    
    cfgOverrides - New session startup parameters.
    
    authBlob - The value to be assigned to SESSION:AUTH-BLOB in the new session.
  - forkNewSession
```
public static void forkNewSession(character cfgOverrides,
                                  java.lang.String authBlob)
```
    Starts a new forked session. Corresponds with the SESSION:NEW-SESSION(character, String) system handle method.
    
    Parameters:
    
    cfgOverrides - New session startup parameters.
    
    authBlob - The value to be assigned to SESSION:AUTH-BLOB in the new session.
  - forkNewSession
```
public static void forkNewSession(java.lang.String cfgOverrides,
                                  java.lang.String authBlob)
```
    Starts a new forked session. Corresponds with the SESSION:NEW-SESSION(String, String) system handle method.
    
    Parameters:
    
    cfgOverrides - New session startup parameters.
    
    authBlob - The value to be assigned to SESSION:AUTH-BLOB in the new session.
  - id
```
public static java.lang.Long id()
```
    Get this resource's ID.
    
    Returns:
    
    The resource's ID.
  - id
```
public static void id(long id)
```
    Set this resource's ID.
    This is a no-op for system handles.
    
    Parameters:
    
    id - The resource's ID.
  - resourceType
```
public static character resourceType()
```
    Get the type of its associated handle.
    
    Returns:
    
    Always return the PSEUDO-WIDGET value.
  - valid
```
public static boolean valid()
```
    Implementation for the WrappedResource.valid() API.
    
    Returns:
    
    Always true.
  - unknown
```
public static boolean unknown()
```
    Implementation for the WrappedResource.unknown() API.
    
    Returns:
    
    Always false.
  - readOnlyError
```
public static void readOnlyError(java.lang.String attribute)
```
    API needed to implement read-only attribute assignment (a 4GL "feature").
    
    Parameters:
    
    attribute - The attribute's name.
    
    See Also:
    
    handle.readOnlyError(handle, String)
  - readOnlyError
```
public static void readOnlyError(java.lang.String attribute,
                                 java.lang.Object expr)
```
    Emitted and to be used only in cases the attribute is read-only. It displays appropriate error message.
    TODO: decide whether the following message can be raised here:
    **Unable to assign UNKNOWN value to attribute <attribute> on <widget id>.
    
    Parameters:
    
    attribute - The read-only attribute.
    
    expr - The value which is attempted to be assigned to the read-only attribute.
  - isRemote
```
public static logical isRemote()
```
    Indicates if the session is for the context of an appserver.
    
    Returns:
    
    true if the session is for the context of an appserver.
  - _isRemote
```
public static boolean _isRemote()
```
    Indicates if the session is for the context of an appserver.
    
    Returns:
    
    true if the session is for the context of an appserver.
  - isClientDisconnected
```
public static logical isClientDisconnected()
```
    Get the CLIENT-DISCONNECTED attribute of this session.
    
    Returns:
    
    true if the FWD client has disconnected (due to an abend, socket close, etc).
  - getTerminationHook
```
public static character getTerminationHook()
```
    Get the TERMINATION-HOOK attribute of this session.
    
    Returns:
    
    See above.
  - setTerminationHook
```
public static void setTerminationHook(character hook)
```
    Set the TERMINATION-HOOK attribute of this session.
    This attribute is valid only for non-remote sessions - for a remote session, a message will be logged.
    
    Parameters:
    
    hook - The hook, a character expression with an external program name or a static method reference following the com.goldencode.Foo:someStaticMethod syntax.
  - setTerminationHook
```
public static void setTerminationHook(java.lang.String hook)
```
    Set the TERMINATION-HOOK attribute of this session.
    
    Parameters:
    
    hook - The hook, a character expression with an external program name or a static method reference following the com.goldencode.Foo:someStaticMethod syntax.
  - getServerOperatingMode
```
public static character getServerOperatingMode()
```
    Method implementation for getting the SERVER-OPERATING-MODE attribute of the session handle.
    Possible values:
    - State-reset
    - State-aware
    - Stateless
    - State-free
    Returns:
    
    The corresponding SERVER-OPERATING-MODE attribute of the session handle.
  - export
```
public static logical export(java.lang.String procList)
```
    Method that specifies the remote procedures the client can execute from the AppServer session.
    
    Parameters:
    
    procList - The list of procedure and name-patterns separated by comma.
    
    Returns:
    
    true if the method succeeded.
  - export
```
public static logical export(character procList)
```
    Method that specifies the remote procedures the client can execute from the AppServer session.
    
    Parameters:
    
    procList - The list of procedure and name-patterns separated by comma.
    
    Returns:
    
    true if the method succeeded.
  - getParameter
```
public static character getParameter()
```
    Get the value of the PARAMETER attribute, which is set to the value of the 4GL -param command line option specified for the current session.
    The following is the precedence order (highest to lowest) for obtaining the value of this parameter:
    - The client command line.
    - The client bootstrap configuration.
    - The directory using relative lookup and the "startup_parameter" node.
    Returns:
    
    The SESSION:PARAMETER value for this context.
  - firstBuffer
```
public static handle firstBuffer()
```
    Returns the handle for the first dynamic buffer in the first table containing a dynamic buffer.
    
    Returns:
    
    See above.
  - firstChild
```
public static handle firstChild()
```
    Returns the handle for the first window in the session.
    
    Returns:
    
    The first window in the session's list of windows.
  - lastChild
```
public static handle lastChild()
```
    Returns the handle for the last window in the session.
    
    Returns:
    
    The last window in the session's list of windows.
  - firstQuery
```
public static handle firstQuery()
```
    Returns the handle for the first created dynamic query.
    TODO: this should call a worker method from the persist package.
    
    Returns:
    
    See above.
  - firstServer
```
public static handle firstServer()
```
    Get the FIRST-SERVER attribute of this session.
    
    Returns:
    
    See above.
  - firstServerSocket
```
public static handle firstServerSocket()
```
    Get the FIRST-SERVER-SOCKET attribute of this session.
    
    Returns:
    
    See above.
  - firstSocket
```
public static handle firstSocket()
```
    Get the FIRST-SOCKET attribute of this session.
    
    Returns:
    
    See above.
  - lastServer
```
public static handle lastServer()
```
    Get the LAST-SERVER attribute of this session.
    
    Returns:
    
    See above.
  - lastServerSocket
```
public static handle lastServerSocket()
```
    Get the LAST-SERVER-SOCKET attribute of this session.
    
    Returns:
    
    See above.
  - lastSocket
```
public static handle lastSocket()
```
    Get the LAST-SOCKET attribute of this session.
    
    Returns:
    
    See above.
  - getFirstDataSet
```
public static handle getFirstDataSet()
```
    Obtain a handle to the first dynamic DataSet object created in the current session.
    The list of Datasets is reversed (it is a stack instead of a queue).
    
    Returns:
    
    the value of SESSION:FIRST-DATASET, as described above.
  - getFirstDataSource
```
public static handle getFirstDataSource()
```
    Obtain a handle to the first dynamic DataSource object created in the current session.
    The list of DataSources is reversed (it is a stack instead of a queue).
    
    Returns:
    
    the value of SESSION:FIRST-DATA-SOURCE, as described above.
  - setDateFormat
```
public static void setDateFormat(java.lang.String dateFormat)
```
    Sets the order of date components (SESSION:DATE-FORMAT) for conversion to/from strings.
    The order of the 3 date sub-components as a 3 character string using "M", "D" and "Y" once each. The order from index 0 to index 2 represents the left to right ordering of the components. So the leftmost date component will be defined by the character at index position 0.
    The value set is specific to the current user's context.
    
    Parameters:
    
    dateFormat - Defines the order of date components for conversion to/from strings.
  - setDateFormat
```
public static void setDateFormat(character dateFormat)
```
    Sets the order of date components (SESSION:DATE-FORMAT) for conversion to/from strings.
    The order of the 3 date sub-components as a 3 character string using "M", "D" and "Y" once each. The order from index 0 to index 2 represents the left to right ordering of the components. So the leftmost date component will be defined by the character at index position 0.
    The value set is specific to the current user's context.
    
    Parameters:
    
    dateFormat - Defines the order of date components for conversion to/from strings.
  - getDateFormat
```
public static character getDateFormat()
```
    Gets the order of date components (SESSION:DATE-FORMAT) for conversion to/from strings.
    The order of the 3 date sub-components is a 3 character string using "M", "D" and "Y" once each. The order from index 0 to index 2 represents the left to right ordering of the components. So the leftmost date component will be defined by the character at index position 0.
    The value accessed is specific to the current user's context.
    
    Returns:
    
    Defines the order of date components for conversion to/from strings.
  - isDebugAlert
```
public static logical isDebugAlert()
```
    Get the state of SESSION:DEBUG-ALERT attribute.
    
    Returns:
    
    the state of SESSION:DEBUG-ALERT attribute.
  - setDebugAlert
```
public static void setDebugAlert(logical on)
```
    Set the state of SESSION:DEBUG-ALERT attribute.
    
    Parameters:
    
    on - The new state for SESSION:DEBUG-ALERT attribute.
  - setDebugAlert
```
public static void setDebugAlert(boolean on)
```
    Set the state of SESSION:DEBUG-ALERT attribute.
    
    Parameters:
    
    on - The new state for SESSION:DEBUG-ALERT attribute.
  - isDataEntryReturn
```
public static logical isDataEntryReturn()
```
    Get the state of SESSION:DATA-ENTRY-RETURN attribute.
    
    Returns:
    
    the state of SESSION:DATA-ENTRY-RETURN attribute.
  - setDataEntryReturn
```
public static void setDataEntryReturn(logical on)
```
    Set the state of SESSION:DATA-ENTRY-RETURN attribute.
    
    Parameters:
    
    on - The new state for SESSION:DATA-ENTRY-RETURN attribute.
  - setDataEntryReturn
```
public static void setDataEntryReturn(boolean on)
```
    Set the state of SESSION:DATA-ENTRY-RETURN attribute.
    
    Parameters:
    
    on - The new state for SESSION:DATA-ENTRY-RETURN attribute.
  - loadIcon
```
public static logical loadIcon(java.lang.String iconName)
```
    Set the state of SESSION:LOAD-ICON attribute.
    
    Parameters:
    
    iconName - The file name of the icon to be loaded
    
    Returns:
    
    true if successful
  - loadIcon
```
public static logical loadIcon(character iconName)
```
    Set the state of SESSION:LOAD-ICON attribute.
    
    Parameters:
    
    iconName - The file name of the icon to be loaded
    
    Returns:
    
    true if successful
  - setSessionTimeZone
```
public static void setSessionTimeZone(NumberType offset)
```
    Sets the SESSION:TIMEZONE used as the default offset in minutes from UTC for this user's context.
    
    Parameters:
    
    offset - The new timezone offset which must be between -840 and 840 inclusive. The value may also be unknown which is the equivalent of resetting this attribute to the default.
  - getSessionTimeZone
```
public static integer getSessionTimeZone()
```
    Accesses the SESSION:TIMEZONE used as the default offset in minutes from UTC for this user's context.
    
    Returns:
    
    The timezone offset. If this has never been set, then unknown will be returned.
  - getSessionTimeSource
```
public static character getSessionTimeSource()
```
    Obtains the currently configured TIME-SOURCE attribute for the current user's context. This attribute is can be read and written but it is not honored for date/time processing in P2J. The intention of the attribute is to define the system from which time values will be obtained. In P2J, time values are always obtained from the application server.
    The default value is "local" which in Progress means that the client machine is the source (this is the same as the empty string ""). It is common to use a database name in the 4GL, which makes the application use the database server as the time source.
    
    Returns:
    
    The time source attribute.
  - setSessionTimeSource
```
public static void setSessionTimeSource(character timeSource)
```
    Sets the TIME-SOURCE attribute for the user's context. This attribute is can be read and written but it is not honored for date/time processing in P2J. The intention of the attribute is to define the system from which time values will be obtained. In P2J, time values are always obtained from the application server.
    
    Parameters:
    
    timeSource - The new value to set. If null, then the empty string will be used, which in the 4GL has the same affect as "local".
  - getSessionDisplayTimeZone
```
public static integer getSessionDisplayTimeZone()
```
    Obtains the currently configured DISPLAY-TIMEZONE attribute for the current user's context. This attribute is used for displaying DATETIME-TZ values that do not have the timezone specified in the display format.
    
    Returns:
    
    The display-timezone attribute.
  - setSessionDisplayTimeZone
```
public static void setSessionDisplayTimeZone(NumberType displayTimezone)
```
    Sets the DISPLAY-TIMEZONE attribute for the user's context. This attribute is used for displaying DATETIME-TZ values that do not have the timezone specified in the display format.
    
    Parameters:
    
    displayTimezone - The new value to set.
  - getYearOffset
```
public static integer getYearOffset()
```
    Implementation of SESSION:YEAR-OFFSET attribute getter. Returns the currently configured start year for the two-digit Y2K windowing range. This is the equivalent to the Progress -yy command line parameter. The default value is 1950 unless otherwise specified in the directory (see date.getWindowingYear()).
    
    Returns:
    
    The start year for the two-digit windowing range.
  - setYearOffset
```
public static void setYearOffset(NumberType year)
```
    Implementation of SESSION:YEAR-OFFSET attribute setter. Sets the configured start year for the two-digit Y2K windowing range. This is the equivalent of the Progress -yy command line parameter. The default value is 1950 unless otherwise specified in the directory (see date.getWindowingYear()).
    
    Parameters:
    
    year - The new start year for the two-digit windowing range.
  - getPixelsPerRow
```
public static integer getPixelsPerRow()
```
    Get the PIXELS-PER-ROW attribute of this session.
    
    Returns:
    
    See above.
  - getPixelsPerColumn
```
public static integer getPixelsPerColumn()
```
    Get the PIXELS-PER-COLUMN attribute of this session.
    
    Returns:
    
    See above.
  - setSessionTooltips
```
public static void setSessionTooltips(logical tooltips)
```
    Sets the SESSION:TOOLTIPS attribute for this session.
    
    Parameters:
    
    tooltips - The new value for session related TOOLTIPS attribute.
  - getSessionTooltips
```
public static logical getSessionTooltips()
```
    Accesses the SESSION:TOOLTIPS attribute for this session.
    
    Returns:
    
    true if tooltips are available for this session false otherwise.
  - is3D
```
public static logical is3D()
```
    Get THREE-D attribute value for SESSION handle.
    
    Returns:
    
    the attribute value
  - set3D
```
public static void set3D(logical value)
```
    Set THREE-D attribute value for SESSION handle.
    
    Parameters:
    
    value - The value to set.
  - getPrinterName
```
public static character getPrinterName()
```
    Get the state of SESSION:PRINTER-NAME attribute.
    
    Returns:
    
    the state of SESSION:PRINTER-NAME attribute.
  - setPrinterName
```
public static void setPrinterName(character value)
```
    Set the state of SESSION:PRINTER-NAME attribute.
    
    Parameters:
    
    value - The new state for SESSION:PRINTER-NAME attribute.
  - getPrinterPort
```
public static character getPrinterPort()
```
    Get the state of SESSION:PRINTER-PORT attribute.
    
    Returns:
    
    the state of SESSION:PRINTER-PORT attribute.
  - setPrinterPort
```
public static void setPrinterPort(character value)
```
    Set the state of SESSION:PRINTER-PORT attribute.
    
    Parameters:
    
    value - The new state for SESSION:PRINTER-PORT attribute.
  - getPrinterControlHandle
```
public static integer getPrinterControlHandle()
```
    Get the state of SESSION:PRINTER-CONTROL-HANDLE attribute.
    
    Returns:
    
    the state of SESSION:PRINTER-CONTROL-HANDLE attribute.
  - setPrinterControlHandle
```
public static void setPrinterControlHandle(integer value)
```
    Set the state of SESSION:PRINTER-CONTROL-HANDLE attribute.
    
    Parameters:
    
    value - The new state for SESSION:PRINTER-CONTROL-HANDLE attribute.
  - getPrinterHDC
```
public static integer getPrinterHDC()
```
    Get the state of SESSION:PRINTER-HDC attribute.
    
    Returns:
    
    the state of SESSION:PRINTER-HDC attribute.
  - getPrinters
```
public static character getPrinters()
```
    The SESSION:GET-PRINTERS method.
    
    Returns:
    
    the result of SESSION:GET-PRINTERS method.
  - isSuppressWarnings
```
public static logical isSuppressWarnings()
```
    Get the state of SESSION:SUPPRESS-WARNINGS attribute.
    
    Returns:
    
    the state of SESSION:SUPPRESS-WARNINGS attribute.
  - setSuppressWarnings
```
public static void setSuppressWarnings(logical value)
```
    Set the state of SESSION:SUPPRESS-WARNINGS attribute.
    
    Parameters:
    
    value - The new state for SESSION:SUPPRESS-WARNINGS attribute.
  - setSuppressWarnings
```
public static void setSuppressWarnings(boolean value)
```
    Set the state of SESSION:SUPPRESS-WARNINGS attribute.
    
    Parameters:
    
    value - The new state for SESSION:SUPPRESS-WARNINGS attribute.
  - getStartupParameters
```
public static character getStartupParameters()
```
    Get the state of SESSION:STARTUP-PARAMETERS attribute.
    
    Returns:
    
    the state of SESSION:STARTUP-PARAMETERS attribute.
  - _startupParameters
```
public static StartupParameters _startupParameters()
```
    Get the startup parameters.
    
    Returns:
    
    the startup parameters object.
  - setStartupParameters
```
public static void setStartupParameters(StartupParameters startupParameters)
```
    Sets the startup parameters.
  - setSystemAlertBoxes
```
public static void setSystemAlertBoxes(boolean on)
```
    Set the state of SESSION:SYSTEM-ALERT-BOXES attribute.
    
    Parameters:
    
    on - The new state for SESSION:SYSTEM-ALERT-BOXES attribute.
  - setSystemAlertBoxes
```
public static void setSystemAlertBoxes(logical on)
```
    Set the state of SESSION:SYSTEM-ALERT-BOXES attribute.
    
    Parameters:
    
    on - The new state for SESSION:SYSTEM-ALERT-BOXES attribute.
  - isSystemAlertBoxes
```
public static logical isSystemAlertBoxes()
```
    Get the state of SESSION:SYSTEM-ALERT-BOXES attribute.
    
    Returns:
    
    the state of SESSION:SYSTEM-ALERT-BOXES attribute.
  - setMultitaskingInterval
```
public static void setMultitaskingInterval(NumberType interval)
```
    Set the value of SESSION:MULTITASKING-INTERVAL attribute.
    
    Parameters:
    
    interval - The new value of SESSION:MULTITASKING-INTERVAL attribute.
  - getMultitaskingInterval
```
public static integer getMultitaskingInterval()
```
    Get the value of SESSION:MULTITASKING-INTERVAL attribute.
    
    Returns:
    
    the value of SESSION:MULTITASKING-INTERVAL attribute.
  - setExitCode
```
public static void setExitCode(long value)
```
    Set the value of SESSION:EXIT-CODE attribute.
    
    Parameters:
    
    value - The new value of SESSION:EXIT-CODE attribute.
  - getExitCode
```
public static long getExitCode()
```
    Get the value of SESSION:EXIT-CODE attribute.
    
    Returns:
    
    the value of SESSION:EXIT-CODE attribute.
  - isServerConnectionBound
```
public static logical isServerConnectionBound()
```
    Get the SERVER-CONNECTION-BOUND attribute of this session.
    
    Returns:
    
    See above.
  - getServerConnectionContext
```
public static character getServerConnectionContext()
```
    Get the SERVER-CONNECTION-CONTEXT attribute of this session.
    
    Returns:
    
    See above.
  - setServerConnectionContext
```
public static void setServerConnectionContext(java.lang.String val)
```
    Set the SERVER-CONNECTION-CONTEXT attribute of this session.
    
    Parameters:
    
    val - The attribute's value.
  - setServerConnectionContext
```
public static void setServerConnectionContext(character val)
```
    Set the SERVER-CONNECTION-CONTEXT attribute of this session.
    
    Parameters:
    
    val - The attribute's value.
  - getServerConnectionId
```
public static character getServerConnectionId()
```
    Get the value of SESSION:SERVER-CONNECTION-ID attribute.
    
    Returns:
    
    the value of SESSION:SERVER-CONNECTION-ID attribute.
  - firstObject
```
public static object<?> firstObject()
```
    Get the FIRST-OBJECT attribute of this session.
    
    Returns:
    
    See above.
  - lastObject
```
public static object<?> lastObject()
```
    Get the LAST-OBJECT attribute of this session.
    
    Returns:
    
    See above.
  - localVersionInfo
```
public static object<? extends OeversionInfo> localVersionInfo()
```
    Get the LOCAL-VERSION-INFO attribute of this session.
    
    Returns:
    
    See above.
  - setClientTypes
```
public static void setClientTypes(ClientType... clientTypes)
```
    This is a helper method setting the value of OEClientType for the session's OeversionInfo. Not exposed in 4GL.
    
    Parameters:
    
    clientTypes - The client types for the session.
  - getClientTypes
```
public static ClientType[] getClientTypes()
```
    This is a helper method returning the value of OEClientType for the session's OeversionInfo. Not exposed in 4GL.
    
    Returns:
    
    See above.
  - getClientType
```
public static character getClientType()
```
    This is a helper method returning the value of OEClientType for the session's OeversionInfo. Not exposed in 4GL.
    
    Returns:
    
    See above.
  - currentRequestInfo
```
public static object<? extends OerequestInfo> currentRequestInfo()
```
    Get the CURRENT-REQUEST-INFO attribute of this session.
    
    Returns:
    
    See above.
  - currentResponseInfo
```
public static object<? extends OerequestInfo> currentResponseInfo()
```
    Get the CURRENT-RESPONSE-INFO attribute of this session.
    
    Returns:
    
    See above.
  - getICFParameter
```
public static character getICFParameter()
```
    Get the ICFPARAMETER attribute of this session.
    
    Returns:
    
    See above.
  - getContextHelpFile
```
public static character getContextHelpFile()
```
    Get the CONTEXT-HELP-FILE attribute of this session.
    
    Returns:
    
    See above.
  - setContextHelpFile
```
public static void setContextHelpFile(java.lang.String file)
```
    Set the CONTEXT-HELP-FILE attribute of this session.
    
    Parameters:
    
    file - The file name.
  - setContextHelpFile
```
public static void setContextHelpFile(character file)
```
    Set the CONTEXT-HELP-FILE attribute of this session.
    
    Parameters:
    
    file - The file name.
  - getServerConnectionBoundRequest
```
public static logical getServerConnectionBoundRequest()
```
    Get the SERVER-CONNECTION-BOUND-REQUEST attribute of this session.
    
    Returns:
    
    See above.
  - setServerConnectionBoundRequest
```
public static void setServerConnectionBoundRequest(boolean state)
```
    Set the SERVER-CONNECTION-BOUND-REQUEST attribute of this session.
    
    Parameters:
    
    state - The bound state.
  - setServerConnectionBoundRequest
```
public static void setServerConnectionBoundRequest(logical state)
```
    Set the SERVER-CONNECTION-BOUND-REQUEST attribute of this session.
    
    Parameters:
    
    state - The bound state.
  - setErrorStackTrace
```
public static void setErrorStackTrace(logical state)
```
    Set the ERROR-STACK-TRACE attribute of this session.
    
    Parameters:
    
    state - The attribute's state.
  - setErrorStackTrace
```
public static void setErrorStackTrace(boolean state)
```
    Set the ERROR-STACK-TRACE attribute of this session.
    
    Parameters:
    
    state - The attribute's state.
  - isErrorStackTrace
```
public static logical isErrorStackTrace()
```
    Get the ERROR-STACK-TRACE attribute of this session.
    
    Returns:
    
    See above.
  - clientDisconnected
```
static void clientDisconnected()
```
    Mark this context as the client has disconnected (due to an abend, socket disconnect, etc).
  - getSuppressWarningsList
```
public static character getSuppressWarningsList()
```
    Get the SUPPRESS-WARNINGS-LIST of this session.
    
    Returns:
    
    See above.
  - setSuppressWarningsList
```
public static void setSuppressWarningsList(java.lang.String list)
```
    Set the SUPPRESS-WARNINGS-LIST attribute of this session.
    
    Parameters:
    
    list - The warning code list.
  - setSuppressWarningsList
```
public static void setSuppressWarningsList(Text list)
```
    Set the SUPPRESS-WARNINGS-LIST attribute of this session.
    
    Parameters:
    
    list - The warning code list.
  - getBrowserExternalIp
```
public static character getBrowserExternalIp()
```
    Returns the external IP of the end-user machine, where the js client runs. Available with web sessions only.
    
    Returns:
    
    See above.
  - setBrowserExternalIp
```
public static void setBrowserExternalIp(java.lang.String browserExternalIp)
```
    Setter for the external IP of the end-user machine, where the js client runs. Available with web sessions only.
    
    Parameters:
    
    browserExternalIp - The external IP of the end-user machine
  - getBrowserPort
```
public static integer getBrowserPort()
```
    Returns the TCP port of the end-user machine, on which the WebSocket runs in the browser. Available with web sessions only.
    
    Returns:
    
    See above.
  - setBrowserPort
```
public static void setBrowserPort(int browserPort)
```
    Setter for the TCP port of the end-user machine, on which the WebSocket runs in the browser. Available with web sessions only.
    
    Parameters:
    
    browserPort - The TCP port of the end-user machine, on which the WebSocket runs in the browser
  - getBrowserTimezone
```
public static integer getBrowserTimezone()
```
    Returns the offset in minutes from UTC for the browser timezone. Available with web sessions only.
    
    Returns:
    
    See above.
  - setBrowserTimezone
```
public static void setBrowserTimezone(int browserTimezone)
```
    Setter for the offset in minutes from UTC for the browser timezone. Available with web sessions only.
    
    Parameters:
    
    browserTimezone - The offset in minutes from UTC for the browser timezone
  - getIpCaptureTime
```
public static datetime getIpCaptureTime()
```
    Returns the UTC datetime of the capture time for BROWSER-EXTERNAL-IP. Available with web sessions only.
    
    Returns:
    
    See above.
  - setIpCaptureTime
```
public static void setIpCaptureTime(long ipCaptureTimestamp)
```
    Setter for the datetime of the capture time for BROWSER-EXTERNAL-IP. Available with web sessions only.
    
    Parameters:
    
    ipCaptureTimestamp - The UTC timestamp of the capture time for BROWSER-EXTERNAL-IP
  - getClientExternalIp
```
public static character getClientExternalIp()
```
    Returns the external IP of the client machine.
    
    Returns:
    
    See above.
  - setClientExternalIp
```
public static void setClientExternalIp(java.lang.String clientExternalIp)
```
    Setter for the external IP of the client machine.
    
    Parameters:
    
    clientExternalIp - The external IP of the client machine
  - getClientPort
```
public static integer getClientPort()
```
    Returns the TCP port of the client machine.
    
    Returns:
    
    See above.
  - setClientPort
```
public static void setClientPort(int clientPort)
```
    Setter for the TCP port of the client machine.
    
    Parameters:
    
    clientPort - The TCP port of the client machine.
  - getClientTimezone
```
public static integer getClientTimezone()
```
    Returns the offset in minutes from UTC for the client machine timezone.
    
    Returns:
    
    See above.
  - setClientTimezone
```
public static void setClientTimezone(int clientTimezone)
```
    Setter for the offset in minutes from UTC for the client machine timezone.
    
    Parameters:
    
    clientTimezone - The offset in minutes from UTC for the client machine timezone
  - getClientIpCaptureTime
```
public static datetime getClientIpCaptureTime()
```
    Returns the UTC datetime of the capture time for CLIENT-EXTERNAL-IP.
    
    Returns:
    
    See above.
  - setClientIpCaptureTime
```
public static void setClientIpCaptureTime(long ipCaptureTimestamp)
```
    Setter for the datetime of the capture time for CLIENT-EXTERNAL-IP.
    
    Parameters:
    
    ipCaptureTimestamp - The UTC timestamp of the capture time for CLIENT-EXTERNAL-IP
  - getScreenColorDepth
```
public static integer getScreenColorDepth()
```
    Returns the client screen color depth.
    
    Returns:
    
    See above.
  - setScreenColorDepth
```
public static void setScreenColorDepth(int screenColorDepth)
```
    Setter for the client screen color depth.
    
    Parameters:
    
    screenColorDepth - The client screen color depth
  - getScreenHeight
```
public static integer getScreenHeight()
```
    Returns the client screen height.
    
    Returns:
    
    See above.
  - setScreenHeight
```
public static void setScreenHeight(int screenHeight)
```
    Setter for the client screen height.
    
    Parameters:
    
    screenHeight - The client screen height
  - getScreenScalingFactor
```
public static decimal getScreenScalingFactor()
```
    Returns the client screen scaling factor.
    
    Returns:
    
    See above.
  - setScreenScalingFactor
```
public static void setScreenScalingFactor(float screenScalingFactor)
```
    Setter for the client screen scaling factor.
    
    Parameters:
    
    screenScalingFactor - The client screen scaling factor
  - getScreenWidth
```
public static integer getScreenWidth()
```
    Returns the client screen width.
    
    Returns:
    
    See above.
  - setScreenWidth
```
public static void setScreenWidth(int screenWidth)
```
    Setter for the client screen width.
    
    Parameters:
    
    screenWidth - The client screen width
  - getUserAgent
```
public static character getUserAgent()
```
    Returns the user agent info of the browser where the js client runs. Available with web sessions only.
    
    Returns:
    
    See above.
  - setUserAgent
```
public static void setUserAgent(java.lang.String userAgent)
```
    Setter for the user agent info of the browser where the js client runs. Available with web sessions only.
    
    Parameters:
    
    userAgent - The user agent
  - setStorageId
```
public static void setStorageId(java.lang.String storageId)
```
    Setter for the storage ID of the end-user (available with SSO).
    
    Parameters:
    
    storageId - The storage ID
  - getStorageId
```
public static java.lang.String getStorageId()
```
    Getter for the storage ID of the end-user (available with SSO).
    
    Returns:
    
    The storage ID.
  - getLoginParam
```
public static character getLoginParam(character paramName)
```
    Returns the first value of the login parameter.
    
    Parameters:
    
    paramName - The name of the login parameter.
    
    Returns:
    
    See above.
  - getLoginParam
```
public static character getLoginParam(java.lang.String paramName)
```
    Returns the first value of the login parameter.
    
    Parameters:
    
    paramName - The name of the login parameter.
    
    Returns:
    
    See above.
  - getLoginParam
```
public static character getLoginParam(character paramName,
                                      integer oeIndex)
```
    Returns the index value of the login parameter.
    
    Parameters:
    
    paramName - The name of the login parameter.
    
    oeIndex - The index of the value of the login parameter. 1-based as in Progress.
    
    Returns:
    
    See above.
  - getLoginParam
```
public static character getLoginParam(character paramName,
                                      int oeIndex)
```
    Returns the index value of the login parameter.
    
    Parameters:
    
    paramName - The name of the login parameter.
    
    oeIndex - The index of the value of the login parameter. 1-based as in Progress.
    
    Returns:
    
    See above.
  - getLoginParam
```
public static character getLoginParam(java.lang.String paramName,
                                      integer oeIndex)
```
    Returns the index value of the login parameter.
    
    Parameters:
    
    paramName - The name of the login parameter.
    
    oeIndex - The index of the value of the login parameter. 1-based as in Progress.
    
    Returns:
    
    See above.
  - getLoginParam
```
public static character getLoginParam(java.lang.String paramName,
                                      int oeIndex)
```
    Returns the index value of the login parameter.
    
    Parameters:
    
    paramName - The name of the login parameter.
    
    oeIndex - The index of the value of the login parameter. 1-based as in Progress.
    
    Returns:
    
    See above.
  - setLoginParams
```
public static void setLoginParams(java.util.Map<java.lang.String,java.lang.String[]> loginParams)
```
    Sets the params sent by the login request. Available with web sessions only.
    
    Parameters:
    
    loginParams - The map of name : values for the params sent by the login request.
  - getLoginParams
```
public static java.util.Map<java.lang.String,java.lang.String[]> getLoginParams()
```
    Returns all login parameters.
    
    Returns:
    
    See above.
  - getWebUploadFiles
```
public static character getWebUploadFiles()
```
    Returns comma delimited string of local file system paths of the files uploaded during direct upload or a comma delimited string of file names chosen during direct file upload.
    
    Returns:
    
    See above.
  - getWebUploadError
```
public static logical getWebUploadError()
```
    Returns {code true} when the current direct upload operation ended with an error, false otherwise.
    
    Returns:
    
    See above.
  - setWebUploadInfo
```
public static void setWebUploadInfo(java.lang.String[] uploadFiles,
                                    boolean error)
```
    Assigns the upload information related to the current direct upload.
    
    Parameters:
    
    uploadFiles - Comma delimited string of local file system paths of the files uploaded during direct upload or a comma delimited string of file names chosen during direct file upload.
    
    error - {code true} when the current direct upload operation ended with an error, false otherwise.

Class SessionUtils

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

work

DEVICE_ID_LOCK

startupParameters

Constructor Detail

SessionUtils

Method Detail

asHandle

getSessionId

setSessionId

setSessionId

getAuthBlob

getDeviceId

setAuthBlob

setDeviceId

getRelatedSessionId

setRelatedSessionId

forkNewSession

forkNewSession

forkNewSession

forkNewSession

id

id

resourceType

valid

unknown

readOnlyError

readOnlyError

isRemote

_isRemote

isClientDisconnected

getTerminationHook

setTerminationHook

setTerminationHook

getServerOperatingMode

export

export

getParameter

firstBuffer

firstChild

lastChild

firstQuery

firstServer

firstServerSocket

firstSocket

lastServer

lastServerSocket

lastSocket

getFirstDataSet

getFirstDataSource

setDateFormat

setDateFormat

getDateFormat

isDebugAlert

setDebugAlert

setDebugAlert

isDataEntryReturn

setDataEntryReturn

setDataEntryReturn

loadIcon

loadIcon

setSessionTimeZone

getSessionTimeZone

getSessionTimeSource

setSessionTimeSource

getSessionDisplayTimeZone

setSessionDisplayTimeZone

getYearOffset

setYearOffset

getPixelsPerRow

getPixelsPerColumn

setSessionTooltips

getSessionTooltips