com.ibm.eNetwork.ECL.screenreco Class ECLSDCondition

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

This class is the descriptor class used to describe a condition that must be true in order for the screen to match. 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.

Note that this class is intended specifically for macro programming. For example, if you have created a variable $user_id$ in your macro, you may want to create condition descriptor with value "$user_id$ == 'Administrator'" -- meaning that the screen will only match if the $user_id$ variable has a value of 'Administrator' at the point when you attempt to match the screen with which this descriptor is associated.

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

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

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
ECLSDCondition ()           Default constructor for a condition descriptor.
ECLSDCondition (java.lang.String cond, boolean opt)           Constructs a condition 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.
 boolean Evaluate ()           Evaluates the condition.
 java.lang.String Format (int argType, boolean displayAll)           Formats the object's contents into a readable string.
 java.lang.String GetCondition ()           Returns the condition to be evaluated by the descriptor.
 void SetCondition (java.lang.String argCond)           Sets the condition to be evaluated by 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

 

Constructor Detail

ECLSDCondition



public 
ECLSDCondition()

ECLSDCondition



public 
ECLSDCondition(java.lang.String cond,
                      boolean opt)

Method Detail

Format



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

GetCondition



public java.lang.String 
GetCondition()

SetCondition



public void 
SetCondition(java.lang.String argCond)
                  throws 
VariableException

Evaluate



public boolean 
Evaluate()

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