All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface org.ohio.iOhioOIA

public interface iOhioOIA
extends iOhio
The operator information area of a host session. This area is used to provide status information regarding the state of the host session and location of the cursor.

An iOhioOIA object can be obtained using the GetOIA() method on an instance of iOhioScreen.

See Also:
iOhioScreen

Method Index

 o addOIAListener(iOhioOIAListener)
Registers a listener object for events dispatched by this iOhioOIA object.
 o getCommCheckCode()
Returns the communication check code.
 o getInputInhibited()
This method returns a value that indicates whether or not input is inhibited.
 o getMachineCheckCode()
Returns the machine check code.
 o getOwner()
Returns the current owner
 o getProgCheckCode()
Returns the program check code.
 o isAlphanumeric()
Indicates whether the field which contains the cursor is an alphanumeric field.
 o isNumeric()
Indicates whether the field which contains the cursor is a numeric-only field.
 o removeOIAListener(iOhioOIAListener)
Unregisters a listener object for events dispatched by this iOhioOIA object.

Methods

 o isAlphanumeric
 public abstract boolean isAlphanumeric()
Indicates whether the field which contains the cursor is an alphanumeric field.

Returns:
True if the cursor is in an alphanumeric field, false otherwise.
 o getCommCheckCode
 public abstract int getCommCheckCode()
Returns the communication check code. If getInputInhibited() returns OHIO_INPUTINHIBITED_COMMCHECK, a call to this method will return the communication check code.

Returns:
The communication check code.
 o getInputInhibited
 public abstract int getInputInhibited()
This method returns a value that indicates whether or not input is inhibited. If input is inhibited, SendKeys or SendAID calls to the iOhioScreen are not allowed. The reason input is inhibited can be determined from the value returned. If input is inhibited for more than one reason, the highest value is returned.

Returns:
One of the following OHIO_INPUTINHIBITED enumeration values:

Inhibit Indicator Value OIA String
OHIO_INPUTINHIBITED_NOTINHIBITED 0
OHIO_INPUTINHIBITED_SYSTEM_WAIT 1 "X SYSTEM" or "X []"
OHIO_INPUTINHIBITED_COMMCHECK 2 "X COMMxxx"
OHIO_INPUTINHIBITED_PROGCHECK 3 "X PROGxxx"
OHIO_INPUTINHIBITED_MACHINECHECK 4 "X MACHxxx"
OHIO_INPUTINHIBITED_OTHER 5

 o getMachineCheckCode
 public abstract int getMachineCheckCode()
Returns the machine check code. If getInputInhibited() returns OHIO_INPUTINHIBITED_MACHINECHECK, a call to this method will return the machine check code.

Returns:
The machine check code.
 o isNumeric
 public abstract boolean isNumeric()
Indicates whether the field which contains the cursor is a numeric-only field.

Returns:
True if the cursor is in a numeric-only field, false otherwise.
 o getOwner
 public abstract int getOwner()
Returns the current owner

Returns:
One of the following OHIO_OWNER enumeration values:

Constant Value Description
OHIO_OWNER_UNKNOWN 0 Uninitialized
OHIO_OWNER_APP 1 Application or 5250 host
OHIO_OWNER_MYJOB 1 3270 - Myjob
OHIO_OWNER_NVT 2 3270 in NVT or VT
OHIO_OWNER_UNOWNED 3 3270 - Unowned
OHIO_OWNER_SSCP 4 3270 - SSCP

 o getProgCheckCode
 public abstract int getProgCheckCode()
Returns the program check code. If getInputInhibited() returns OHIO_INPUTINHIBITED_PROGCHECK, a call to this method will return the program check code.

Returns:
The program check code.
 o addOIAListener
 public abstract void addOIAListener(iOhioOIAListener listener)
Registers a listener object for events dispatched by this iOhioOIA object. The listener object must implement the iOhioOIAListener interface.

Listener objects can be unregistered using the removeOIAListener() method.

Parameters:
listener - iOhioOIAListener object which is notified when iOhioOIA events occur.
See Also:
removeOIAListener
 o removeOIAListener
 public abstract void removeOIAListener(iOhioOIAListener listener)
Unregisters a listener object for events dispatched by this iOhioOIA object.

Listener objects can be registered using the addOIAListener() method.

Parameters:
listener - iOhioOIAListener object which is to be removed from the notification list.
See Also:
addOIAListener

All Packages  Class Hierarchy  This Package  Previous  Next  Index