com.ibm.eNetwork.ECL.screenreco
Class ECLSDVarUpdate

java.lang.Object
  |
  +--com.ibm.eNetwork.ECL.screenreco.ECLScreenDescriptor
        |
        +--com.ibm.eNetwork.ECL.screenreco.ECLSDVarUpdate

All Implemented Interfaces:

com.ibm.eNetwork.HOD.common.HODConstants, java.io.Serializable

public class ECLSDVarUpdate

extends ECLScreenDescriptor

This class is the descriptor class used to update a variable at the time of attempted screen recognition during macro play. 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: This is informational for Macro bean programming only and cannot be used directly in HACL-only programming.

The variable update descriptor specifies the variable to be updated as well as the new value to assign to the variable. This class is a "descriptor" only in that the variable update occurs at the time of screen recognition; it has no bearing on whether the screen actually matches.

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, ECLSDOIA, ECLSDString, 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_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

ECLSDVarUpdate()
Default constructor for a variable update descriptor.

ECLSDVarUpdate(java.lang.String argName, java.lang.String argValue)
Constructs a variable update 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.
java.lang.String	GetName() Returns the name of the variable being updated by this descriptor
java.lang.String	GetValue() Returns the expression form of the new value for the variable being updated by this descriptor
void	SetName(java.lang.String argName) Sets the name of the variable for the descriptor.
void	SetValue(java.lang.String argValue) Sets the new value of the variable for the descriptor

Methods inherited from class com.ibm.eNetwork.ECL.screenreco.ECLScreenDescriptor

IsInvertMatch, IsInvertMatchRaw, IsMatch, IsOptional, IsOptionalRaw, SetInvertMatch, SetInvertMatch, SetMatch, SetOptional, SetOptional

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ECLSDVarUpdate

public ECLSDVarUpdate()

Default constructor for a variable update descriptor.

If you use this constructor you must call all the set methods of this class to properly set up the descriptor.

ECLSDVarUpdate

public ECLSDVarUpdate(java.lang.String argName,
                      java.lang.String argValue)

Constructs a variable update descriptor with the given parameters.

This constructor will create a usable descriptor. No set methods need be called.

Parameters:

argName - name of variable to be updated

argValue - new value for specified variable

Method Detail

SetName

public void SetName(java.lang.String argName)

Sets the name of the variable for the descriptor.

Parameters:

argName - name of the variable for the descriptor

SetValue

public void SetValue(java.lang.String argValue)

Sets the new value of the variable for the descriptor

Parameters:

argExpression - new value for the specified variable

GetName

public java.lang.String GetName()

Returns the name of the variable being updated by this descriptor

Returns:

variable name

GetValue

public java.lang.String GetValue()

Returns the expression form of the new value for the variable being updated by this descriptor

Returns:

expression form of the new variable value

Format

public java.lang.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.

Overrides:

Format in class ECLScreenDescriptor

Parameters:

argType - reserved for future use

displayAll - if true all returned string contains all tags including those that are not explicitly set else returned string contains only those tags that are explicitly set

Returns:

formatted string that reflects the contents of the descriptor

Create

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

Creates a working instance of the descriptor from the string values contained in the hash table.

Overrides:

Create in class ECLScreenDescriptor

Parameters:

argTable - hash table that contains all the valid parameters.
Consult this document: Host Access Beans for Java : Appendix A. Macro Script Syntax