com.ibm.eNetwork.beans.HOD
Class MacroActionCommWait

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

public class MacroActionCommWait
extends MacroAction

This class represents one communication wait action associated with a MacroScreen object. The communication wait action is used for inserting a communication status wait during the execution of macro actions.

See Also:
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
MacroActionCommWait()
          Constructs an empty instance of a macro communication wait.
MacroActionCommWait(int argType, int argTimeout)
          Constructs a functional instance of a macro communication wait with the given parameters.
 
Method Summary
 void execute()
          Executes the comm wait action.
 java.lang.String format(int argType, boolean formatAll)
          Formats the action object's contents into a readable string.
 long getTimeout()
          Returns the timeout for communication wait.
 java.lang.String getTimeoutRaw()
          Returns the expression form of the timeout for communication wait.
 long getWaitType()
          Returns the communication type of the action.
 java.lang.String getWaitTypeRaw()
          Returns the expression form of the communication type of the action.
 void halt()
          Halts the action.
 void setTimeout(int argTimeout)
          Sets the timeout for communication wait.
 void setTimeout(java.lang.String argTimeout)
          Sets the timeout for communication wait.
 void setWaitType(int argType)
          Sets the type of communication event.
 void setWaitType(java.lang.String argType)
          Sets the type of communication event.
 
Methods inherited from class com.ibm.eNetwork.beans.HOD.MacroAction
clone, equals, 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

MacroActionCommWait

public MacroActionCommWait()
Constructs an empty instance of a macro communication wait.

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


MacroActionCommWait

public MacroActionCommWait(int argType,
                           int argTimeout)
Constructs a functional instance of a macro communication wait with the given parameters.
Parameters:
argType - communication type to wait for. Allowed values are defined in ECLConnection
argTimeout - timeout value for wait in milliseconds
See Also:
ECLConnection
Method Detail

execute

public void execute()
Executes the comm wait action. Waits for a connection to be established. If a connection could not be established, the macro is stopped and a MacroErrorEvent is fired. setOwner must have been called with a Macro object that is associated with a ECLSession. Otherwise the method throws a NullPointerException
Overrides:
execute in class MacroAction

halt

public void halt()
Halts the action.
Overrides:
halt in class MacroAction

setWaitType

public void setWaitType(int argType)
Sets the type of communication event. The default is ECLConnection.CONNECTION_READY.
Parameters:
argType - new communication wait type

setWaitType

public void setWaitType(java.lang.String argType)
Sets the type of communication event. The default is ECLConnection.CONNECTION_READY.
Parameters:
expression - new communication wait type

getWaitType

public long getWaitType()
Returns the communication type of the action.
Returns:
communication wait type for the action

getWaitTypeRaw

public java.lang.String getWaitTypeRaw()
Returns the expression form of the communication type of the action.
Returns:
expression form of the communication wait type for the action

setTimeout

public void setTimeout(int argTimeout)
Sets the timeout for communication wait.
Parameters:
argTimeout - new timeout value

setTimeout

public void setTimeout(java.lang.String argTimeout)
Sets the timeout for communication wait.
Parameters:
expression - new timeout value

getTimeout

public long getTimeout()
Returns the timeout for communication wait.
Returns:
timeout value for the wait

getTimeoutRaw

public java.lang.String getTimeoutRaw()
Returns the expression form of the timeout for communication wait.
Returns:
expression form of the timeout value for the wait

format

public java.lang.String format(int argType,
                               boolean formatAll)
Formats the action object's contents into a readable string. Intended for visual feedback, like with the MacroDebugActionEvent class.
Overrides:
format in class MacroAction
Parameters:
argType - reserved, currently only XML strings are supported
formatAll - if true, optional parameters will be formatted also
Returns:
formatted string that reflects the contents of the action