com.ibm.eNetwork.beans.HOD
Class MacroActionTrace

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

public class MacroActionTrace
extends MacroAction
implements java.io.Serializable

This class represents one trace action associated with a MacroScreen object. Trace actions in a macro fires trace data to one of three places depending on the type set. If the type is TRACE_HOD, the trace data goes to the IBM Host On-Demand trace facility. If the type is TRACE_USER, the data goes to any registered runtime listeners on the Macro Bean. If the type is TRACE_SYSOUT, the data simply goes to the command line.

See Also:
Macro, MacroTraceEvent, Serialized Form

Field Summary
static int TRACE_HOD
          Trace data will be sent to the HOD trace facility.
static int TRACE_SYSOUT
          Trace data will be sent to the command line.
static int TRACE_USER
          Trace data will be fired to any registered listeners.
 
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
MacroActionTrace()
          Constructs an empty instance of a macro trace action.
MacroActionTrace(java.lang.String argData, int argType)
          Constructs a functional instance of a macro trace action with the given parameters.
 
Method Summary
 void execute()
          Executes the macro trace action.
 java.lang.String format(int argType, boolean displayAll)
          Formats the contents of the action object into a readable string.
 java.lang.String getTraceData()
          Returns the data for the trace.
 java.lang.String getTraceDataRaw()
          Returns the expression form of the data for the trace.
 int getTraceType()
          Returns the trace type.
 java.lang.String getTraceTypeRaw()
          Returns the expression form of the trace type.
 void setTraceData(java.lang.String argData)
          Sets the data for the trace.
 void setTraceType(int argTraceType)
          Sets the trace type.
 void setTraceType(java.lang.String argTraceType)
          Sets the trace type.
 
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
 

Field Detail

TRACE_HOD

public static final int TRACE_HOD
Trace data will be sent to the HOD trace facility.

TRACE_USER

public static final int TRACE_USER
Trace data will be fired to any registered listeners.

TRACE_SYSOUT

public static final int TRACE_SYSOUT
Trace data will be sent to the command line.
Constructor Detail

MacroActionTrace

public MacroActionTrace()
Constructs an empty instance of a macro trace action.

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


MacroActionTrace

public MacroActionTrace(java.lang.String argData,
                        int argType)
Constructs a functional instance of a macro trace action with the given parameters.
Parameters:
argType - type of trace for the Macro bean to perform
argData - data to send to the trace facility
See Also:
TRACE_HOD, TRACE_USER, TRACE_SYSOUT
Method Detail

format

public java.lang.String format(int argType,
                               boolean displayAll)
Formats the contents of the action object into a readable string. Intended for visual feedback, as with the MacroDebugActionEvent class.
Overrides:
format in class MacroAction
Parameters:
argType - type of string to produce
displayAll - if true, optional parameters will be formatted also
Returns:
formatted string that reflects the contents of the action

execute

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

getTraceType

public int getTraceType()
Returns the trace type.
Returns:
type of trace
See Also:
TRACE_HOD, TRACE_USER, TRACE_SYSOUT

getTraceTypeRaw

public java.lang.String getTraceTypeRaw()
Returns the expression form of the trace type.
Returns:
expression form of the type of trace
See Also:
TRACE_HOD, TRACE_USER, TRACE_SYSOUT

setTraceType

public void setTraceType(int argTraceType)
Sets the trace type.
Parameters:
argType - type of trace for the Macro bean to perform
See Also:
TRACE_HOD, TRACE_USER, TRACE_SYSOUT

setTraceType

public void setTraceType(java.lang.String argTraceType)
Sets the trace type.
Parameters:
expression - type of trace for the Macro bean to perform
See Also:
TRACE_HOD, TRACE_USER, TRACE_SYSOUT

getTraceData

public java.lang.String getTraceData()
Returns the data for the trace.
Returns:
trace data string

getTraceDataRaw

public java.lang.String getTraceDataRaw()
Returns the expression form of the data for the trace.
Returns:
expression form of the trace data string

setTraceData

public void setTraceData(java.lang.String argData)
Sets the data for the trace.
Parameters:
argData - data to send to the trace facility