com.ibm.eNetwork.beans.HOD
Class MacroAction

java.lang.Object
  |
  +--com.ibm.eNetwork.beans.HOD.MacroAction
All Implemented Interfaces:
com.ibm.eNetwork.HOD.common.HODConstants, com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable, java.io.Serializable
Direct Known Subclasses:
MacroActionBoxSelect, MacroActionCommWait, MacroActionCustom, MacroActionExtract, MacroActionIf, MacroActionInput, MacroActionMessage, MacroActionMouseClick, MacroActionPause, MacroActionPlayMacro, MacroActionPrompt, MacroActionRunProgram, MacroActionTrace, MacroActionVarUpdate

public abstract class MacroAction
extends java.lang.Object
implements java.io.Serializable, com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable, com.ibm.eNetwork.HOD.common.HODConstants

The MacroAction class is the parent class of all macro actions allowable for the Macro bean. Macro action represents one unique action that is interpretable by the Macro bean. These actions can be prompts, data extraction from the screen, screen input, and the like. Each of these types of actions has its own class that is derived from MacroAction.

When an action object is instantiated, it may be added to an object of the MacroActions class. The MacroActions object may then be used to construct a MacroScreen object, which is the basic unit within a macro. When the screen corresponding to the MacroScreen object appears from the host, the actions in the MacroActions collection for the MacroScreen will be executed by the Macro bean.

Refer to each action class for details on each action.

See Also:
Macro, MacroScreen, MacroActions, MacroActionExtract, MacroActionInput, MacroActionMessage, MacroActionPause, MacroActionPrompt, MacroActionCustom, MacroActionBoxSelect, MacroActionCommWait, MacroActionMouseClick, MacroActionTrace, MacroActionVarUpdate, MacroActionIf, MacroActionRunProgram, MacroActionPlayMacro, Serialized Form

Fields inherited from interface com.ibm.eNetwork.HOD.common.HODConstants
DEFAULT_WIN_FONT, HOD_ICON_EVENT, HOD_MSG_FILE, 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_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_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
 
Method Summary
 java.lang.Object clone()
          Classes derived from this action must override this method for the action to be functional in the Macro bean.
 void execute()
          Classes derived from this action must override this method for the action to be functional in the Macro bean.
 java.lang.String format(int type, boolean displayAll)
          Returns a formatted string representation of the action.
 void halt()
          Classes derived from this action must override this method to do any cleanup handling if the Macro bean calls this method to stop an action in the middle of its execution.
 void setECLSession(com.ibm.eNetwork.ECL.ECLSession sess)
          Sets the Host Access Class Library session object of the action.
 void setOwner(Macro mac)
          Sets the owner of the action.
 void setRuntimeListeners(java.util.Vector v)
          Sets the runtime listeners of the action.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable
setAttributes, setError
 

Method Detail

execute

public void execute()
Classes derived from this action must override this method for the action to be functional in the Macro bean. This method is called by the Macro bean to execute an action.

halt

public void halt()
Classes derived from this action must override this method to do any cleanup handling if the Macro bean calls this method to stop an action in the middle of its execution.

setOwner

public void setOwner(Macro mac)
Sets the owner of the action.
Parameters:
mac - new Macro bean owner of the action

clone

public java.lang.Object clone()
Classes derived from this action must override this method for the action to be functional in the Macro bean. This method is called by the Macro bean to clone an action.

setRuntimeListeners

public void setRuntimeListeners(java.util.Vector v)
Sets the runtime listeners of the action.
Parameters:
v - new Vector of MacroRuntimeListeners

setECLSession

public void setECLSession(com.ibm.eNetwork.ECL.ECLSession sess)
Sets the Host Access Class Library session object of the action.
Parameters:
sess - new HACL session object of the action

format

public java.lang.String format(int type,
                               boolean displayAll)
Returns a formatted string representation of the action.
Specified by:
format in interface com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable
Parameters:
type - reserved, currently only XML strings are supported
displayAll - if true, all optional parameters are also formatted.