com.ibm.are.report
Interface StatusReporting

All Superinterfaces:
Reporting
All Known Subinterfaces:
PluginReporting, ReporterReporting
All Known Implementing Classes:
BasePlugin, BasePlugin.ReporterCollection

public interface StatusReporting
extends Reporting

The StatusReporting interface defines the set of methods used for reporting status in the ARE environment. Status reporting is structured in a hierarchical fashion, allowing cascading levels of status detail to be reported.

The hierarchy of reporting is:

Additional levels of reporting can be achieved by using the generic report(String, int) method.

Version:
1.0
Author:
IBM

Field Summary
static java.lang.String COPYRIGHT
          Copyright for class bytecode
 
Fields inherited from interface com.ibm.are.report.Reporting
FORMAT_BINARY, FORMAT_HTML, FORMAT_PLAIN_TEXT, FORMAT_SERIALIZED, FORMAT_USER_DEFINED, FORMAT_XML, LEVEL_ERROR, LEVEL_INFO, LEVEL_NONE, LEVEL_WARNING, MAX_REPORT_DEPTH, MIN_REPORT_DEPTH
 
Method Summary
 void report(java.lang.String msg, int depth)
          Report a message at the given level in the reporting hierarchy.
 void reportFinish(com.ibm.are.core.Element elem, ResultInfo result)
          Reports the result of the runtime processing for a plugin.
 void reportStart(com.ibm.are.core.Element elem)
          Reports the start of a plugin
 void reportStatistic(java.lang.String description, java.lang.Object value, int depth)
          Reports an interesting or very important statistic.
 void reportStep(java.lang.String msg)
          Reports a new step in the runtime processing.
 void reportStepDetail(java.lang.String msg)
          Reports a new step detail in the runtime processing.
 void reportSubStep(java.lang.String msg)
          Reports a new sub step in the runtime processing.
 void reportSubStepDetail(java.lang.String msg)
          Reports a new sub step detail in the runtime processing.
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
Copyright for class bytecode

See Also:
Constant Field Values
Method Detail

reportStart

void reportStart(com.ibm.are.core.Element elem)
Reports the start of a plugin

Parameters:
elem - The plugin that is starting

reportFinish

void reportFinish(com.ibm.are.core.Element elem,
                  ResultInfo result)
Reports the result of the runtime processing for a plugin.

Parameters:
result - The result

reportStep

void reportStep(java.lang.String msg)
Reports a new step in the runtime processing. A step is the topmost node in the status reporting hierarchy.

Parameters:
msg - The message to report

reportStepDetail

void reportStepDetail(java.lang.String msg)
Reports a new step detail in the runtime processing. A 'step detail' is the direct child of a 'step' in the reporting status hierarchy.

Parameters:
msg - The message to report

reportSubStep

void reportSubStep(java.lang.String msg)
Reports a new sub step in the runtime processing. A 'sub step' is the direct child of a 'step detail' in the reporting status hierarchy.

Parameters:
msg - The message to report

reportSubStepDetail

void reportSubStepDetail(java.lang.String msg)
Reports a new sub step detail in the runtime processing. A 'sub step detail' is the direct child of a 'sub step' in the reporting status hierarchy.

Parameters:
msg - The message to report

reportStatistic

void reportStatistic(java.lang.String description,
                     java.lang.Object value,
                     int depth)
Reports an interesting or very important statistic.

Parameters:
description - A description of the statistic being reported
value - The (statistic) value to report
depth - The depth in the status reporting hierarchy where the statistic will be reported

report

void report(java.lang.String msg,
            int depth)
Report a message at the given level in the reporting hierarchy.

Parameters:
msg - The message to print
depth - The level within the reporting hierarchy. If this parameter were set to 1 it would be equivalent to invoking the reportStep(String) method. The valid value ranges from MIN_REPORT_DEPTH (include) to MAN_REPORT_DEPTH (include).