com.ibm.eNetwork.beans.HOD
Class MacroActionVarUpdate

java.lang.Object
  |
  +--com.ibm.eNetwork.beans.HOD.MacroAction
        |
        +--com.ibm.eNetwork.beans.HOD.MacroActionVarUpdate
All Implemented Interfaces:
com.ibm.eNetwork.HOD.common.HODConstants, com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable, java.io.Serializable

public class MacroActionVarUpdate
extends MacroAction

This class represents one variable update action associated with a MacroScreen object. The variable update action is used for updating the value of a variable while the macro is running.

See Also:
Macro, 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
MacroActionVarUpdate()
          Default constructor for a variable update action.
MacroActionVarUpdate(java.lang.String argName, java.lang.String argValue)
          Constructs a variable update action with the given parameters.
 
Method Summary
 void execute()
          Executes the macro variable update action.
 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 action
 java.lang.String getValue()
          Returns the expression form of the new value for the variable being updated by this action
 void setName(java.lang.String argName)
          Sets the name of the variable for the action.
 void setValue(java.lang.String argValue)
          Sets the new value of the variable for the action
 
Methods inherited from class com.ibm.eNetwork.beans.HOD.MacroAction
clone, equals, halt, setECLSession, setOwner, setRuntimeListeners
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable
setAttributes, setError
 

Constructor Detail

MacroActionVarUpdate

public MacroActionVarUpdate()
Default constructor for a variable update action.

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


MacroActionVarUpdate

public MacroActionVarUpdate(java.lang.String argName,
                            java.lang.String argValue)
Constructs a variable update action 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 action.
Parameters:
argName - name of the variable for the action

getName

public java.lang.String getName()
Returns the name of the variable being updated by this action
Returns:
variable name

setValue

public void setValue(java.lang.String argValue)
Sets the new value of the variable for the action
Parameters:
argExpression - new value for the specified variable

getValue

public java.lang.String getValue()
Returns the expression form of the new value for the variable being updated by this action
Returns:
expression form of the new variable value

execute

public void execute()
Executes the macro variable update action.
Overrides:
execute in class MacroAction

format

public java.lang.String format(int argType,
                               boolean displayAll)
Formats the action object's contents into a readable string. Intended for visual feedback, as with the MacroDebugActionEvent class.

Overrides:
format in class MacroAction
Parameters:
argType - reserved, currently only XML strings are supported
displayAll - if true, optional parameters are formatted also
Returns:
formatted string that reflects the contents of the action