com.ibm.eNetwork.beans.HOD
Class MacroActionPlayMacro

java.lang.Object
  |
  +--com.ibm.eNetwork.beans.HOD.MacroAction
        |
        +--com.ibm.eNetwork.beans.HOD.MacroActionPlayMacro

All Implemented Interfaces:

com.ibm.eNetwork.HOD.common.HODConstants, com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable, java.io.Serializable

public class MacroActionPlayMacro

extends MacroAction

This class represents one play macro action associated with a MacroScreen object. The play macro action is used for chaining a macro during the execution of macro actions to play another macro. Current macro stops before playing the chained macro.

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

MacroActionPlayMacro()
Constructs an instance of default MacroActionPlayMacro.

MacroActionPlayMacro(java.lang.String n)
Constructs an instance of MacroActionPlayMacro with macro name specified.

MacroActionPlayMacro(java.lang.String n, java.lang.String ss)
Constructs an instance of MacroActionPlayMacro with macro name and start screen name specified.

MacroActionPlayMacro(java.lang.String n, java.lang.String ss, java.lang.String xType)
Constructs an instance of MacroActionPlayMacro with macro name, start screen name, and a type of variable transfer specified.

MacroActionPlayMacro(java.lang.String n, java.lang.String ss, java.lang.String xType, java.lang.String i)
Constructs an instance of MacroActionPlayMacro with macro name, start screen name, a type of variable transfer, and macro chain ID specified.

Method Summary

void	execute() Executes the play macro action.
java.lang.String	format(int argType, boolean formatAll) Formats the action object's contents into a readable string.
java.lang.String	getName() Returns a name of a chained macro
java.lang.String	getStartScreen() Returns a name of starting screen of a chained macro
java.lang.String	getXferVarType() Returns macro variable transfer type
void	setID(java.lang.String i) Sets chained macro ID
void	setName(java.lang.String n) Sets chained macro name
void	setStartScreen(java.lang.String ss) Sets chained macro's start screen
void	setXferVarType(java.lang.String xType) Sets variable transfer type

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

MacroActionPlayMacro

public MacroActionPlayMacro()

Constructs an instance of default MacroActionPlayMacro.

MacroActionPlayMacro

public MacroActionPlayMacro(java.lang.String n)

Constructs an instance of MacroActionPlayMacro with macro name specified. Macro chain ID will be set to macro name by default.

Parameters:

n - name of macro

MacroActionPlayMacro

public MacroActionPlayMacro(java.lang.String n,
                            java.lang.String ss)

Constructs an instance of MacroActionPlayMacro with macro name and start screen name specified. Macro chain ID will be set to macro name by default.

Parameters:

n - name of macro

ss - start screen of a macro

MacroActionPlayMacro

public MacroActionPlayMacro(java.lang.String n,
                            java.lang.String ss,
                            java.lang.String xType)

Constructs an instance of MacroActionPlayMacro with macro name, start screen name, and a type of variable transfer specified. Macro chain ID will be set to macro name by default.

Parameters:

n - name of macro

ss - start screen of a macro

xType - variable transfer type (Transfer/No Transfer)

MacroActionPlayMacro

public MacroActionPlayMacro(java.lang.String n,
                            java.lang.String ss,
                            java.lang.String xType,
                            java.lang.String i)

Constructs an instance of MacroActionPlayMacro with macro name, start screen name, a type of variable transfer, and macro chain ID specified.

Parameters:

n - name of macro

ss - start screen of a macro

xType - variable transfer type (Transfer/No Transfer)

i - macro chain ID

Method Detail

getName

public java.lang.String getName()

Returns a name of a chained macro

getStartScreen

public java.lang.String getStartScreen()

Returns a name of starting screen of a chained macro

getXferVarType

public java.lang.String getXferVarType()

Returns macro variable transfer type

setName

public void setName(java.lang.String n)

Sets chained macro name

setStartScreen

public void setStartScreen(java.lang.String ss)

Sets chained macro's start screen

setXferVarType

public void setXferVarType(java.lang.String xType)

Sets variable transfer type

setID

public void setID(java.lang.String i)

Sets chained macro ID

execute

public void execute()

Executes the play macro action.

Overrides:

execute in class MacroAction

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