com.ibm.eNetwork.beans.HOD
Class MacroActionPause

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

public class MacroActionPause
extends MacroAction

This class represents one pause action associated with a MacroScreen object. The pause action is used for inserting a pause 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
MacroActionPause()
          Constructs an empty instance of a macro pause.
MacroActionPause(long argDuration)
          Constructs a functional instance of a macro pause with the given parameter.
MacroActionPause(long argDuration, boolean argIgnore)
          Constructs a functional instance of a macro pause with the given parameters.
 
Method Summary
 void execute()
          Executes the pause action.
 java.lang.String format(int argType, boolean formatAll)
          Formats the action object's contents into a readable string.
 boolean getIgnorePauseOverrideForEnhancedTN()
          Returns true if pause will be ignored, false otherwise.
 java.lang.String getIgnorePauseOverrideForEnhancedTNRaw()
          Returns the expression form of the pause policy.
 long getTimeout()
          Returns the duration of the pause action.
 java.lang.String getTimeoutRaw()
          Returns the expression form of the duration of the pause action.
 void halt()
          Halts the pause action.
 void setIgnorePauseOverrideForEnhancedTN(boolean argPause)
          Set if pause should be ignored.
 void setIgnorePauseOverrideForEnhancedTN(java.lang.String argPause)
          Set if pause should be ignored.
 void setTimeout(long argTimeout)
          Sets the duration of the pause action.
 void setTimeout(java.lang.String argTimeout)
          Sets the duration of the pause action.
 
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

MacroActionPause

public MacroActionPause()
Constructs an empty instance of a macro pause.

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


MacroActionPause

public MacroActionPause(long argDuration)
Constructs a functional instance of a macro pause with the given parameter.
Parameters:
argDuration - pause duration in milliseconds

MacroActionPause

public MacroActionPause(long argDuration,
                        boolean argIgnore)
Constructs a functional instance of a macro pause with the given parameters.
Parameters:
argDuration - pause duration in milliseconds
argIgnore - igonore pause if session is in contention-resolution mode
Method Detail

execute

public void execute()
Executes the pause action.
Overrides:
execute in class MacroAction

halt

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

setTimeout

public void setTimeout(long argTimeout)
Sets the duration of the pause action. The default pause is 10000 milliseconds (10 seconds).
Parameters:
argTimeout - new pause duration in milliseconds

setTimeout

public void setTimeout(java.lang.String argTimeout)
Sets the duration of the pause action. The default pause is 10000 milliseconds (10 seconds).
Parameters:
expression - new pause duration in milliseconds

getTimeout

public long getTimeout()
Returns the duration of the pause action.
Returns:
pause duration for the action

getTimeoutRaw

public java.lang.String getTimeoutRaw()
Returns the expression form of the duration of the pause action.
Returns:
expression form of the pause duration for the action

getIgnorePauseOverrideForEnhancedTN

public boolean getIgnorePauseOverrideForEnhancedTN()
Returns true if pause will be ignored, false otherwise. If setIgnorePauseOverrideForEnhancedTN was not invoked earlier and if this pause action is associated with a Macro, this will return the global pause value as specified by the global "ignorepauseforenhancedtn" parameter.
Returns:
true if the pause will be ignored, false otherwise
See Also:
com.ibm.eNetwork.beans.HOD.MacroScreens#setIgnorePauseForEnhancedTN()

setIgnorePauseOverrideForEnhancedTN

public void setIgnorePauseOverrideForEnhancedTN(java.lang.String argPause)
Set if pause should be ignored. This value overrides the global paramter "ignorepauseforenhancedtn" in HAScript element for this pause action.
Parameters:
argPause - true if the pause should be ignored, false otherwise
See Also:
com.ibm.eNetwork.beans.HOD.MacroScreens#setIgnorePauseForEnhancedTN()

setIgnorePauseOverrideForEnhancedTN

public void setIgnorePauseOverrideForEnhancedTN(boolean argPause)
Set if pause should be ignored. This value overrides the global paramter "ignorepauseforenhancedtn" in HAScript element for this pause action.
Parameters:
argPause - true if the pause should be ignored, false otherwise
See Also:
com.ibm.eNetwork.beans.HOD.MacroScreens#setIgnorePauseForEnhancedTN()

getIgnorePauseOverrideForEnhancedTNRaw

public java.lang.String getIgnorePauseOverrideForEnhancedTNRaw()
Returns the expression form of the pause policy.
Returns:
expression form of the pause policy

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