Attachmate Verastream SDK for UMC Reference Guide v4.0
A C F G I M O P R S T W

A

addIScreenListener(EventListener) - Method in interface com.attachmate.UPG.common.IScreenUPG
Adds the ScreenListener, which allows your application to receive various screen and/or status event notifications, to the Screen object.

C

Close() - Method in interface com.attachmate.UPG.common.IScreenUPG
Closes the current host session.
CursorPositionException - exception com.attachmate.emulation.exception.CursorPositionException.
Indicates that either the setCursor, setCursorColumn, or setCursorRow method was not able to complete successfully because an invalid cursor position was specified.
CursorPositionException() - Constructor for class com.attachmate.emulation.exception.CursorPositionException
 
CursorPositionException(String) - Constructor for class com.attachmate.emulation.exception.CursorPositionException
 
clearCapturedData() - Method in interface com.attachmate.UPG.common.IScreenUPG
Clears information from the captured data buffer by setting it to null.
com.attachmate.common.types - package com.attachmate.common.types
 
com.attachmate.emulation.exception - package com.attachmate.emulation.exception
 
copyright - Static variable in class com.attachmate.UPG.SessionLoader.SessionException
 
copyright - Static variable in class com.attachmate.UPG.SessionLoader.SessionLoader
 
copyright - Static variable in interface com.attachmate.UPG.common.IScreenUPG
 
copyright - Static variable in interface com.attachmate.UPG.screen.IScreenListener
 
copyright - Static variable in interface com.attachmate.UPG.screen.IStatusListener
 
copyright - Static variable in class com.attachmate.common.types.MutableInt
 
copyright - Static variable in class com.attachmate.emulation.exception.CursorPositionException
 
copyright - Static variable in class com.attachmate.emulation.exception.InputInhibitedException
 
copyright - Static variable in class com.attachmate.emulation.exception.ProtectedFieldException
 
copyright - Static variable in class com.attachmate.emulation.exception.TimedOutException
 
copyright - Static variable in class com.attachmate.emulation.exception.TruncatedException
 

F

fieldCount(int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the number of fields of the specified type.
findField(int, int, int, int, int, MutableInt, MutableInt, MutableInt, MutableInt) - Method in interface com.attachmate.UPG.common.IScreenUPG
Searches the presentation space for the specified field, beginning from the row and column position specified.
findFieldEx(int, int, int, int, MutableInt, MutableInt, MutableInt, MutableInt) - Method in interface com.attachmate.UPG.common.IScreenUPG
Searches the presentation space for the specified field, beginning from the index (field number) specified.
findString(String, int, int, MutableInt, MutableInt) - Method in interface com.attachmate.UPG.common.IScreenUPG
Searches the presentation space for the specified text string, starting at the specified position.
findStringEx(String, int, int, int, int, int, int, int, MutableInt, MutableInt) - Method in interface com.attachmate.UPG.common.IScreenUPG
Searches the presentation space for the specified text string, from the specified start position to the specified end position.

G

getCapturedBytes() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the currently captured data as a byte array.
getCapturedData() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the currently captured data as a String.
getColumns() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the number of columns in the current presentation space.
getConfigurationIPAddress() - Method in class com.attachmate.UPG.SessionLoader.SessionLoader
Deprecated. As of Version 4.0, XML configurations should be passed in by application using SessionLoader.requestScreenEx(String, String, String, int)
getCursor(MutableInt, MutableInt) - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the current cursor position.
getCursorColumn() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the column of the current cursor position.
getCursorRow() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the row of the current cursor position.
getDataCapture() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the current state of the data capture facility: true if on; false if off.
getDescription() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns a custom description for the Screen object, if a description was created previously using setDescription.
getExtPS(int, int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the specified portion of the presentation space in a string format.
getExtPSBytes(int, int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the specified portion of the presentation space in a byte array format.
getKeyboardLocked() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the current state of the keyboard: true if locked; false if unlocked.
getLastError() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns a description of the most recent error that occurred.
getMaxDataCaptureLength() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the current maximum buffer size for data captured using the data capture facility.
getOIAByteContents() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the data displayed in the OIA portion (status line) of the presentation space.
getOIAContents() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the data displayed in the OIA portion (status line) of the presentation space.
getOIAText() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the text of the OIA portion (status line) of the presentation space in a string format.
getObjectVersion() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the version number of the specified Screen object (4xxxyyy); for example, 3001000 is equivalent to version 3.1.00.
getOperatorDisable() - Method in interface com.attachmate.UPG.common.IScreenUPG
Gets the current Operator Disabled status for MATIP sessions.
getPeripheralControl() - Method in interface com.attachmate.UPG.common.IScreenUPG
Gets the current Peripheral Control State for UTS INT-1 sessions.
getRows() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the number of rows in the presentation space.
getScreenType() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the current host type.
getString(int, int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the visible text from the specified location.
getStringEx(int, int, int, int, int, int, int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns text from the specified location, for attributes matching those specified by inAttr.
getTerminalType() - Method in class com.attachmate.UPG.SessionLoader.SessionLoader
Gets the default Screen Type to be used for retrieving Screen Objects.
getText() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the text contents of the presentation space as a string.
getgetText_Display() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the current setting of the getText_Display property.

I

IScreenListener - interface com.attachmate.UPG.screen.IScreenListener.
Provides programmatic access to events generated by the host presentation space.
IScreenUPG - interface com.attachmate.UPG.common.IScreenUPG.
 
IStatusListener - interface com.attachmate.UPG.screen.IStatusListener.
Provides programmatic access to events generated by the transport.
InputInhibitedException - exception com.attachmate.emulation.exception.InputInhibitedException.
Indicates that the putString or putStringEx method was not able to complete successfully because a field with the input inhibited attribute was encountered.
InputInhibitedException() - Constructor for class com.attachmate.emulation.exception.InputInhibitedException
 
InputInhibitedException(String) - Constructor for class com.attachmate.emulation.exception.InputInhibitedException
 
isConnected() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the state of the Mainframe/Gateway connection: true if connected; false if unconnected.
isKeyboardLocked() - Method in interface com.attachmate.UPG.common.IScreenUPG
Returns the state of the keyboard: true if locked; false if unlocked.

M

MutableInt - class com.attachmate.common.types.MutableInt.
Wrapper class for fundamental type int.
MutableInt() - Constructor for class com.attachmate.common.types.MutableInt
Constructor to initialize the instance of the class.
MutableInt(int) - Constructor for class com.attachmate.common.types.MutableInt
Constructor to initialize the instance of the class.

O

Open() - Method in interface com.attachmate.UPG.common.IScreenUPG
Opens a host session.
OpenEx(int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Opens a host session, waiting a specified time for the connection to be established before returning.
onConnectionLost() - Method in interface com.attachmate.UPG.screen.IScreenListener
Event generated when the connection to the host is broken.
onError(ErrorEvent) - Method in interface com.attachmate.UPG.screen.IScreenListener
Event generated when an error occurs.
onLostRemoteWindow() - Method in interface com.attachmate.UPG.screen.IScreenListener
Event generated when the Remote Window closes.
onScreenChanged(ScreenChangedEvent) - Method in interface com.attachmate.UPG.screen.IScreenListener
Event generated when any part of the host screen changes.
onScreenShapeChanged(ScreenShapeChangeEvent) - Method in interface com.attachmate.UPG.screen.IScreenListener
Event generated when the host screen shape (number of rows and/or columns) changes.
onStatusReceived(short, byte[]) - Method in interface com.attachmate.UPG.screen.IStatusListener
Event generated when any status message is received from the transport.

P

ProtectedFieldException - exception com.attachmate.emulation.exception.ProtectedFieldException.
Indicates that the putString or putStringEx method was not able to complete successfully because a protected field was encountered.
ProtectedFieldException() - Constructor for class com.attachmate.emulation.exception.ProtectedFieldException
 
ProtectedFieldException(String) - Constructor for class com.attachmate.emulation.exception.ProtectedFieldException
 
putString(String, int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Copies a string of text to the specified position in the presentation space, returning the number of characters written.
putStringEx(String, int, int, int, int, int, int, int, boolean) - Method in interface com.attachmate.UPG.common.IScreenUPG
Copies a string of text to the specified position in the presentation space, returning the number of characters written.

R

RawDataTransmit(String) - Method in interface com.attachmate.UPG.common.IScreenUPG
Writes a string of characters directly to the host communications layer, without going through the presentation space.
RawDataTransmitBytes(byte[]) - Method in interface com.attachmate.UPG.common.IScreenUPG
Writes an array of bytes directly to the host communications layer, without going through the presentation space.
removeIScreenListener(EventListener) - Method in interface com.attachmate.UPG.common.IScreenUPG
Removes the ScreenListener from the Screen object.
requestScreen(String, String, String) - Method in class com.attachmate.UPG.SessionLoader.SessionLoader
Deprecated. As of Version 4.0, XML configurations should be passed in by application using SessionLoader.requestScreenEx(String, String, String, int)
requestScreenEx(String, String, String, int) - Method in class com.attachmate.UPG.SessionLoader.SessionLoader
Gets a Screen object, instantiated with the specified user and password, as well as the configuration specified by the XML Data.

S

SendStatus(int, byte[]) - Method in interface com.attachmate.UPG.common.IScreenUPG
Sends a status message with option detail to screen.
SessionException - exception com.attachmate.UPG.SessionLoader.SessionException.
Describes possible reasons why the SessionLoader class can fail.
SessionException() - Constructor for class com.attachmate.UPG.SessionLoader.SessionException
 
SessionException(String) - Constructor for class com.attachmate.UPG.SessionLoader.SessionException
 
SessionLoader - class com.attachmate.UPG.SessionLoader.SessionLoader.
Initializes the specified host session.
SessionLoader() - Constructor for class com.attachmate.UPG.SessionLoader.SessionLoader
 
Shutdown() - Method in class com.attachmate.UPG.SessionLoader.SessionLoader
Deprecated. As of Version 4.0, session ID management should be handled by application.
sendKeys(String, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Sends characters and special keys to the session.
setConfigurationIPAddress(String) - Method in class com.attachmate.UPG.SessionLoader.SessionLoader
Deprecated. As of Version 4.0, XML configurations should be passed in by application using SessionLoader.requestScreenEx(String, String, String, int)
setCursor(int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Sets the cursor position on the presentation space.
setCursorColumn(int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Sets the column of the cursor position.
setCursorRow(int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Sets the row of the cursor position.
setDataCapture(boolean) - Method in interface com.attachmate.UPG.common.IScreenUPG
Turns the data capture facility on or off.
setDataCaptureEx(boolean, boolean) - Method in interface com.attachmate.UPG.common.IScreenUPG
Turns the data capture facility on or off.
setDescription(String) - Method in interface com.attachmate.UPG.common.IScreenUPG
Creates a custom description for the Screen object.
setMaxDataCaptureLength(int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Sets the maximum buffer size for data captured using the data capture facility.
setOperatorDisable(boolean) - Method in interface com.attachmate.UPG.common.IScreenUPG
Attempts to set Operator Disabled status for MATIP sessions.
setPeripheralControl(boolean) - Method in interface com.attachmate.UPG.common.IScreenUPG
Sets the Peripheral Control State for UTS INT-1 sessions.
This advanced feature is for applications that want control over print activity.

The "setPeripheralControl" method is called for an application to either establish or relinquish control over peripheral status response generation (i.e.
setResourceManagerOptions(int, int, String) - Method in class com.attachmate.UPG.SessionLoader.SessionLoader
Deprecated. As of Version 4.0, session ID management should be handled by application.
setTerminalType(int) - Method in class com.attachmate.UPG.SessionLoader.SessionLoader
Sets a default Screen Type to be used for retrieving Screen Objects.
setgetText_Display(boolean) - Method in interface com.attachmate.UPG.common.IScreenUPG
Turns the getText_Display property on or off.

T

TimedOutException - exception com.attachmate.emulation.exception.TimedOutException.
Indicates that a wait method has timed out before the wait condition was satisfied.
TimedOutException() - Constructor for class com.attachmate.emulation.exception.TimedOutException
 
TimedOutException(String) - Constructor for class com.attachmate.emulation.exception.TimedOutException
 
TruncatedException - exception com.attachmate.emulation.exception.TruncatedException.
Indicates that there is not enough room in the presentation space to write all of the data specified by the putString or putStringEx method.
TruncatedException() - Constructor for class com.attachmate.emulation.exception.TruncatedException
 
TruncatedException(String) - Constructor for class com.attachmate.emulation.exception.TruncatedException
 

W

waitForCursor(int, int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Waits for the cursor to appear at the specified position, for a specified period of time.
waitForString(String, int, int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Waits for the specified text to appear at the specified position, for a specified period of time.
waitHostQuiet(int, int) - Method in interface com.attachmate.UPG.common.IScreenUPG
Waits for the host session to be idle for a specified period of time (in milliseconds).

A C F G I M O P R S T W
Attachmate Verastream SDK for UMC Reference Guide v4.0