com.ibm.eNetwork.ECL Class ECLOIA

Overview   Package     Class   Tree   Serialized   Deprecated   Index   Help   API User's Guide  
  PREV CLASS     NEXT CLASS FRAMES     NO FRAMES
SUMMARY:  INNER |  FIELD | CONSTR |  METHOD DETAIL:   FIELD | CONSTR |  METHOD 


java.lang.Object
  |
  +--
com.ibm.eNetwork.ECL.ECLOIA
public class ECLOIA
extends java.lang.Object

ECLOIA represents the operator information area (OIA) of a session. An instance of ECLOIA can only be obtained using the GetOIA() method on ECLSession.

ECLOIA provides methods to determine the insert state as well as information about the cursor location, such as whether the current field is alphanumeric or whether the current character is a DBCS character. It also provides methods which return reminder conditions such as for communications errors or for waiting messages (5250 only).

See Also:
ECLSession

Field Summary
static int INHIBIT_COMMCHECK            
static int INHIBIT_MACHCHECK            
static int INHIBIT_NOTINHIBITED            
static int INHIBIT_OTHERINHIBIT            
static int INHIBIT_PROGCHECK            
static int INHIBIT_SYSTEMWAIT            
static int STATE_A_ONLINE            
static int STATE_APL            
static int STATE_CLEAR_DO_NOT_ENTER            
static int STATE_COMM_CHECK            
static int STATE_COMM_ERR_REM            
static int STATE_CONTROLLER_READY            
static int STATE_DO_NOT_ENTER            
static long STATE_DOC_MODE            
static int STATE_ELSEWHERE            
static int STATE_ENCRYPT            
static int STATE_FN_MINUS            
static int STATE_GR_CURSOR            
static int STATE_HOD_CONTROL            
static int STATE_HOST_CONTROL            
static int STATE_HOST_WRITE            
static int STATE_INPUT_ERROR            
static int STATE_INSERT            
static int STATE_MORE_THAN            
static int STATE_MSG_WAITING            
static int STATE_MY_JOB            
static int STATE_NO_CHANGE            
static int STATE_OIA_SUPPRESS            
static int STATE_OP_SYS            
static int STATE_PROG_CHECK            
static int STATE_SYM_MINUS            
static int STATE_SYS_LOCK            
static int STATE_TIME            
static int STATE_UNOWNED            
static int STATE_WHAT_KEY            
static long STATE_WORDWRAP            

 

Method Summary
 long getOIAEventDelay ()           Get the OIAEvent delay value.
  ECLSession GetParent ()           Get the parent of this ECLOIA which is an instance of ECLSession.
 int GetStatusFlags ()           This method returns the current status flags of the OIA.
 int InputInhibited ()           This method returns a value that indicates whether or not input is inhibited.
 boolean IsAlphanumeric ()           Determines if the field which contains the cursor is an alphanumeric field.
 boolean IsCommErrorReminder ()           This method reports on the status of the communications error reminder condition.
 boolean IsDBCS ()           Determines if current cursor location is a double-byte character.
 boolean IsInsertMode ()           Determines if the keyboard is in insert mode.
 boolean IsMessageWaiting ()           This method reports on the status of the message waiting indicator.
 boolean IsNumeric ()           Determines if the field which contains the cursor is a numeric-only field.
 void RegisterOIAEvent ( ECLOIANotify notify)           Registers a notification object for events dispatched by a single instance of ECLOIA.
 void setOIAEventDelay (long delay)           Set OIAEvent delay value if the connection is NOT operating in contention resolution mode.
 void UnregisterOIAEvent ( ECLOIANotify notify)           Unregisters a notification object previously registered with the RegisterOIAEvent() method.
 boolean WaitForInput ()           Synchronously waits indefinitely until the OIA input is not inhibited.
 boolean WaitForInput (long timeOut)           For the time passed in, synchronously waits until the OIA input is not inhibited.

 

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

 

Field Detail

INHIBIT_NOTINHIBITED



public static final int 
INHIBIT_NOTINHIBITED

INHIBIT_SYSTEMWAIT



public static final int 
INHIBIT_SYSTEMWAIT

INHIBIT_COMMCHECK



public static final int 
INHIBIT_COMMCHECK

INHIBIT_PROGCHECK



public static final int 
INHIBIT_PROGCHECK

INHIBIT_MACHCHECK



public static final int 
INHIBIT_MACHCHECK

INHIBIT_OTHERINHIBIT



public static final int 
INHIBIT_OTHERINHIBIT

STATE_NO_CHANGE



public static final int 
STATE_NO_CHANGE

STATE_CONTROLLER_READY



public static final int 
STATE_CONTROLLER_READY

STATE_A_ONLINE



public static final int 
STATE_A_ONLINE

STATE_MY_JOB



public static final int 
STATE_MY_JOB

STATE_OP_SYS



public static final int 
STATE_OP_SYS

STATE_UNOWNED



public static final int 
STATE_UNOWNED

STATE_TIME



public static final int 
STATE_TIME

STATE_SYS_LOCK



public static final int 
STATE_SYS_LOCK

STATE_COMM_CHECK



public static final int 
STATE_COMM_CHECK

STATE_PROG_CHECK



public static final int 
STATE_PROG_CHECK

STATE_ELSEWHERE



public static final int 
STATE_ELSEWHERE

STATE_FN_MINUS



public static final int 
STATE_FN_MINUS

STATE_WHAT_KEY



public static final int 
STATE_WHAT_KEY

STATE_MORE_THAN



public static final int 
STATE_MORE_THAN

STATE_SYM_MINUS



public static final int 
STATE_SYM_MINUS

STATE_INPUT_ERROR



public static final int 
STATE_INPUT_ERROR

STATE_OIA_SUPPRESS



public static final int 
STATE_OIA_SUPPRESS

STATE_HOST_CONTROL



public static final int 
STATE_HOST_CONTROL

STATE_HOST_WRITE



public static final int 
STATE_HOST_WRITE

STATE_HOD_CONTROL



public static final int 
STATE_HOD_CONTROL

STATE_DO_NOT_ENTER



public static final int 
STATE_DO_NOT_ENTER

STATE_CLEAR_DO_NOT_ENTER



public static final int 
STATE_CLEAR_DO_NOT_ENTER

STATE_INSERT



public static final int 
STATE_INSERT

STATE_APL



public static final int 
STATE_APL

STATE_GR_CURSOR



public static final int 
STATE_GR_CURSOR

STATE_COMM_ERR_REM



public static final int 
STATE_COMM_ERR_REM

STATE_MSG_WAITING



public static final int 
STATE_MSG_WAITING

STATE_ENCRYPT



public static final int 
STATE_ENCRYPT

STATE_DOC_MODE



public static final long 
STATE_DOC_MODE

STATE_WORDWRAP



public static final long 
STATE_WORDWRAP

Method Detail

IsAlphanumeric



public boolean 
IsAlphanumeric()

IsDBCS



public boolean 
IsDBCS()

IsNumeric



public boolean 
IsNumeric()

IsInsertMode



public boolean 
IsInsertMode()

IsCommErrorReminder



public boolean 
IsCommErrorReminder()

IsMessageWaiting



public boolean 
IsMessageWaiting()

InputInhibited



public int 
InputInhibited()

GetStatusFlags



public int 
GetStatusFlags()

WaitForInput



public boolean 
WaitForInput()

WaitForInput



public boolean 
WaitForInput(long timeOut)

RegisterOIAEvent



public void 
RegisterOIAEvent(
ECLOIANotify notify)

UnregisterOIAEvent



public void 
UnregisterOIAEvent(
ECLOIANotify notify)

GetParent



public 
ECLSession 

            GetParent()

setOIAEventDelay



public void 
setOIAEventDelay(long delay)

getOIAEventDelay



public long 
getOIAEventDelay()

Overview   Package     Class   Tree   Serialized   Deprecated   Index   Help   API User's Guide  
  PREV CLASS     NEXT CLASS FRAMES     NO FRAMES
SUMMARY:  INNER |  FIELD | CONSTR |  METHOD DETAIL:   FIELD | CONSTR |  METHOD