All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.eNetwork.ECL.screenreco.ECLSDOIA
java.lang.Object
|
+----com.ibm.eNetwork.ECL.screenreco.ECLScreenDescriptor
|
+----com.ibm.eNetwork.ECL.screenreco.ECLSDOIA
- 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.
- See Also:
- ECLScreenReco, ECLScreenDesc, ECLScreenDescriptor, ECLSDAttrib, ECLSDCursor, ECLSDCustom, ECLSDFields, ECLSDInputFields, ECLSDString, ECLPS, ECLField
-
OIA_DONTCARE
- OIA wait type.
-
OIA_NOTINHIBITED
- OIA wait type.
-
ECLSDOIA()
- Default constructor for a string descriptor.
-
ECLSDOIA(int, boolean)
- Constructs an OIA descriptor with the given parameters.
-
Create(Hashtable)
- Creates a working instance of the descriptor from the string values
contained in the hash table.
-
Format(int, boolean)
- Formats the action object's contents into a readable string.
-
GetOIAType()
- Returns the OIA type for the descriptor.
-
SetOIAType(int)
- Sets the OIA type for the descriptor.
OIA_NOTINHIBITED
public static final int OIA_NOTINHIBITED
- OIA wait type. 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.
OIA_DONTCARE
public static final int OIA_DONTCARE
- OIA wait type. Will cause the matching logic to ignore OIA state.
ECLSDOIA
public ECLSDOIA()
- Default constructor for a string descriptor. OIA type will be
OIA_NOTINHIBITED.
If you use this constructor you must call all the set methods of this
class to properly set up the descriptor.
ECLSDOIA
public ECLSDOIA(int oiatype,
boolean opt)
- Constructs an OIA descriptor with the given parameters.
This constructor will create a usable descriptor. No set methods
need be called.
- Parameters:
- type - OIA state type for the descriptor
- opt - if true, descriptor is optional
- See Also:
- OIA_NOTINHIBITED, OIA_DONTCARE
Format
public String Format(int argType,
boolean displayAll)
- Formats the action object's contents into a readable string. Intended
for visual feedback, like with the ECLRecoDebugEvent class.
- Parameters:
- argType - type of string to produce (reserved for future use)
- displayAll - formats the default values also
- Returns:
- formatted string that reflects the contents of the descriptor
- Overrides:
- Format in class ECLScreenDescriptor
GetOIAType
public int GetOIAType()
- Returns the OIA type for the descriptor.
- Returns:
- OIA type
- See Also:
- OIA_NOTINHIBITED, OIA_DONTCARE
SetOIAType
public void SetOIAType(int type)
- Sets the OIA type for the descriptor.
- Parameters:
- type - OIA type for the descriptor
- See Also:
- OIA_NOTINHIBITED, OIA_DONTCARE
Create
public Vector Create(Hashtable argTable)
- Creates a working instance of the descriptor from the string values
contained in the hash table.
- Parameters:
- argTable - hash table that contains all the valid parameters. Consult Host Access Beans for Java : Appendix A. Macro Script Syntax
- Overrides:
- Create in class ECLScreenDescriptor
All Packages Class Hierarchy This Package Previous Next Index