com.ibm.eNetwork.beans.HOD
Class MacroActionRunProgram

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

public class MacroActionRunProgram
extends MacroAction

This class represents one run program action associated with a MacroScreen object. The specified command is executed by the runtime in a separate process.

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_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
 
Constructor Summary
MacroActionRunProgram()
          Constructs an empty instance of a macro run program action.
MacroActionRunProgram(java.lang.String argExec, java.lang.String argParam, boolean argWait)
          Constructs a functional instance of a macro run program action with the given parameters.
 
Method Summary
 void execute()
          Executes the macro run program action.
 java.lang.String format(int argType, boolean formatAll)
          Formats the action object's contents into a readable string.
 java.lang.String getAssignToVar()
          Returns the name of the variable to which the exit value is being assigned.
 java.lang.String getExec()
          Returns the program text
 java.lang.String getExecRaw()
          Returns the expression form of the program text
 java.lang.String getParam()
          Returns the param text
 java.lang.String getParamRaw()
          Returns the expression form of the param text
 boolean isAssignToVar()
          Returns whether the exit value is being assigned to a variable.
 boolean isWait()
          Returns whether the macro will wait for the program to execute
 java.lang.String isWaitRaw()
          Returns the expression form of whether the macro will wait for the program to execute
 void setAssignToVar(java.lang.String argAssign)
          Sets the variable to receive the exit value
 void setExec(java.lang.String argExec)
          Sets the program text.
 void setParam(java.lang.String argParam)
          Sets the program param.
 void setWait(boolean argWait)
          Sets whether the macro will wait for the program to execute
 void setWait(java.lang.String argWait)
          Sets whether the macro will wait for the program to execute
 
Methods inherited from class com.ibm.eNetwork.beans.HOD.MacroAction
clone, halt, setECLSession, setOwner, setRuntimeListeners
 
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
 

Constructor Detail

MacroActionRunProgram

public MacroActionRunProgram()
Constructs an empty instance of a macro run program action.

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


MacroActionRunProgram

public MacroActionRunProgram(java.lang.String argExec,
                             java.lang.String argParam,
                             boolean argWait)
Constructs a functional instance of a macro run program action with the given parameters.
Parameters:
argExec - program text
argParam - param string
argWait - if true, macro waits for the program to execute before continuing
Method Detail

execute

public void execute()
Executes the macro run program action.
Overrides:
execute in class MacroAction

getExec

public java.lang.String getExec()
Returns the program text
Returns:
program string

getExecRaw

public java.lang.String getExecRaw()
Returns the expression form of the program text
Returns:
program string

setExec

public void setExec(java.lang.String argExec)
Sets the program text.
Parameters:
argProgram - program string to set

getParam

public java.lang.String getParam()
Returns the param text
Returns:
param string

getParamRaw

public java.lang.String getParamRaw()
Returns the expression form of the param text
Returns:
param string

setParam

public void setParam(java.lang.String argParam)
Sets the program param.
Parameters:
argParam - Param string to set

isWait

public boolean isWait()
Returns whether the macro will wait for the program to execute
Returns:
if true, the macro will wait for the program to execute before continuing

isWaitRaw

public java.lang.String isWaitRaw()
Returns the expression form of whether the macro will wait for the program to execute
Returns:
if expression evaluates to true, the macro will wait for the program to execute before continuing

setWait

public void setWait(boolean argWait)
Sets whether the macro will wait for the program to execute
Parameters:
argWait - if true, the macro will wait for the program to execute

setWait

public void setWait(java.lang.String argWait)
Sets whether the macro will wait for the program to execute
Parameters:
expression - if expression evaluates to true, the macro will wait for the program to execute

getAssignToVar

public java.lang.String getAssignToVar()
Returns the name of the variable to which the exit value is being assigned. If not assigning to a variable, this method returns an empty string.
Returns:
name of variable being updated with the exit value

isAssignToVar

public boolean isAssignToVar()
Returns whether the exit value is being assigned to a variable. You must specify to wait for the program to execute if you want to assign the exit value to a variable.
Returns:
if true, the exit value is being assigned to a variable

setAssignToVar

public void setAssignToVar(java.lang.String argAssign)
Sets the variable to receive the exit value
Parameters:
argAssign - name of the variable

format

public java.lang.String format(int argType,
                               boolean formatAll)
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
formatAll - if true, optional parameters will be formatted also
Returns:
formatted string that reflects the contents of the action