com.ibm.eNetwork.ECL.screenreco Class ECLSDOIA

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.screenreco.ECLScreenDescriptor
        |
        +--
com.ibm.eNetwork.ECL.screenreco.ECLSDOIA
All Implemented Interfaces:
com.ibm.eNetwork.HOD.common.HODConstants, java.io.Serializable
public class ECLSDOIA
extends ECLScreenDescriptor

This class is the descriptor class used to describe an OIA condition to wait for after a host screen is recognized. When the descriptor is instantiated, it may be added to an object of the ECLScreenDesc class. The ECLScreenDesc class may then be used in either the ECLScreenReco class or the ECLPS WaitForScreen methods to reliably wait for the screen described by ECLScreenDesc to appear in the Presentation Space.

The OIA descriptor may specify a wait condition of either OIA_NOTINHIBITED or OIA_DONTCARE by using the SetOIAType method. The default is OIA_NOTINHIBITED. A wait condition of OIA_NOTINHIBITED will cause the matching logic to fail the ECLScreenDesc object until the host screen OIA indicates that input is not inhibited. A not inhibited condition generally means you may type on the screen. A wait condition of OIA_DONTCARE will cause the matching logic to ignore the OIA state altogether.

Once you have created the descriptor, you may add it to an ECLScreenDesc object by calling ECLScreenDesc.AddDescriptor.

Note that some of the methods below are intended specifically for macro programming, as indicated.

See Also:
ECLScreenReco , ECLScreenDesc , ECLScreenDescriptor , ECLSDAttrib , ECLSDCursor , ECLSDCustom , ECLSDFields , ECLSDInputFields , ECLSDString , ECLSDVarUpdate , ECLPS , ECLField , Serialized Form

Field Summary
static int OIA_DONTCARE           OIA wait type.
static int OIA_NOTINHIBITED           OIA wait type.

 

Fields inherited from interface com.ibm.eNetwork.HOD.common.HODConstants
DEFAULT_WIN_FONT, HOD_ICON_EVENT, HOD_MSG_FILE, HOD_RAS_COMPID_ADVMACRO, HOD_RAS_COMPID_ASSOC_PRT, HOD_RAS_COMPID_BLINKREMAP, HOD_RAS_COMPID_CODEPAGE, HOD_RAS_COMPID_COLORREMAP, HOD_RAS_COMPID_CONFIG, HOD_RAS_COMPID_DATAACCESS, HOD_RAS_COMPID_FILETRANSFER, HOD_RAS_COMPID_FTP_SCREEN, HOD_RAS_COMPID_FTP_SESSION, HOD_RAS_COMPID_FTP_TERMINAL, HOD_RAS_COMPID_FUDOMA, HOD_RAS_COMPID_HOD_API, HOD_RAS_COMPID_IMPEXP, HOD_RAS_COMPID_JNILOAD, HOD_RAS_COMPID_KEYPAD, HOD_RAS_COMPID_KEYREMAP, HOD_RAS_COMPID_MACRO, HOD_RAS_COMPID_MACROMANGR, HOD_RAS_COMPID_PRT_TERMINAL, HOD_RAS_COMPID_SCREEN, HOD_RAS_COMPID_SESSION, HOD_RAS_COMPID_SESSION_MGR, HOD_RAS_COMPID_SLP, HOD_RAS_COMPID_TERMINAL, HOD_RAS_COMPID_ZIPPRINT, HOD_RAS_FUNC_NAME, HOD_START_UP, HOD_TRANSFER_FILE_INFO, MOUSE_DOUBLE_CLICK_THRESHOLD, XFER_ASCII_GET_OPTIONS, XFER_ASCII_GET_OPTIONS_DEFAULT, XFER_ASCII_PUT_OPTIONS, XFER_ASCII_PUT_OPTIONS_DEFAULT, XFER_BINARY_GET_OPTIONS, XFER_BINARY_GET_OPTIONS_DEFAULT, XFER_BINARY_PUT_OPTIONS, XFER_BINARY_PUT_OPTIONS_DEFAULT, XFER_DEFAULT_OPTIONS, XFER_FILETYPE_DTA, XFER_FILETYPE_SAVF, XFER_FILETYPE_SRC, XFER_HOST_TYPE, XFER_HOST_TYPE_CICS, XFER_HOST_TYPE_CMS, XFER_HOST_TYPE_DEFAULT, XFER_HOST_TYPE_OS400, XFER_HOST_TYPE_TSO, XFER_PACKET_SIZE, XFER_PACKET_SIZE_DEFAULT, XFER_TIME_OUT_VALUE, XFER_TIME_OUT_VALUE_DEFAULT, XFER_TRANSFER_MODE, XFER_TRANSFER_MODE_ASCII, XFER_TRANSFER_MODE_BINARY, XFER_TRANSFER_MODE_DEFAULT

 

Constructor Summary
ECLSDOIA ()           Default constructor for a string descriptor.
ECLSDOIA (int oiatype, boolean opt)           Constructs an OIA descriptor with the given parameters.
ECLSDOIA (java.lang.String hostid)           Constructs an OIA descriptor with a Host ID and an OIA type of OIA_NOTINHIBITED.
ECLSDOIA (java.lang.String hostid, int oiatype, boolean opt)           Constructs an OIA descriptor with the given parameters.

 

Method Summary
 java.util.Vector Create (java.util.Hashtable argTable)           Creates a working instance of the descriptor from the string values contained in the hash table.
 java.lang.String Format (int argType, boolean displayAll)           Formats the action object's contents into a readable string.
 int GetOIAType ()           Returns the OIA type for the descriptor.
 java.lang.String GetOIATypeRaw ()           Returns the expression form of the OIA type for the descriptor.
 void SetOIAType (int type)           Sets the OIA type for the descriptor.
 void SetOIAType (java.lang.String argType)           Sets the OIA type for the descriptor.

 

Methods inherited from class com.ibm.eNetwork.ECL.screenreco. ECLScreenDescriptor
GetHostid, GetHostidRaw, IsInvertMatch, IsInvertMatchRaw, IsMatch, IsMultiSessionDescriptor, IsOptional, IsOptionalRaw, SetHostid, SetInvertMatch, SetInvertMatch, SetMatch, SetOptional, SetOptional

 

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

 

Field Detail

OIA_NOTINHIBITED



public static final int 
OIA_NOTINHIBITED

OIA_DONTCARE



public static final int 
OIA_DONTCARE

Constructor Detail

ECLSDOIA



public 
ECLSDOIA()

ECLSDOIA



public 
ECLSDOIA(java.lang.String hostid)

ECLSDOIA



public 
ECLSDOIA(int oiatype,
                boolean opt)

ECLSDOIA



public 
ECLSDOIA(java.lang.String hostid,
                int oiatype,
                boolean opt)

Method Detail

Format



public java.lang.String 
Format(int argType,
                               boolean displayAll)

GetOIAType



public int 
GetOIAType()

GetOIATypeRaw



public java.lang.String 
GetOIATypeRaw()

SetOIAType



public void 
SetOIAType(int type)

SetOIAType



public void 
SetOIAType(java.lang.String argType)

Create



public java.util.Vector 
Create(java.util.Hashtable argTable)

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