All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.eNetwork.beans.HOD.MacroActionTrace
java.lang.Object
|
+----com.ibm.eNetwork.beans.HOD.MacroAction
|
+----com.ibm.eNetwork.beans.HOD.MacroActionTrace
- public class MacroActionTrace
- extends MacroAction
- implements 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
-
TRACE_HOD
- Trace data will be sent to the HOD trace facility.
-
TRACE_SYSOUT
- Trace data will be sent to the command line.
-
TRACE_USER
- Trace data will be fired to any registered listeners.
-
MacroActionTrace()
- Constructs an empty instance of a macro trace action.
-
MacroActionTrace(String, int)
- Constructs a functional instance of a macro trace action with the given
parameters.
-
execute()
- Executes the macro trace action.
-
format(int, boolean)
- Formats the contents of the action object into a readable string.
-
getTraceData()
- Returns the data for the trace.
-
getTraceType()
- Returns the trace type.
-
setTraceData(String)
- Sets the data for the trace.
-
setTraceType(int)
- Sets the trace type.
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.
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(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
format
public 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.
- 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
- Overrides:
- format in class MacroAction
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
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
getTraceData
public String getTraceData()
- Returns the data for the trace.
- Returns:
- trace data string
setTraceData
public void setTraceData(String argData)
- Sets the data for the trace.
- Parameters:
- argData - data to send to the trace facility
All Packages Class Hierarchy This Package Previous Next Index