|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StatusReporting
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.
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 |
---|
static final java.lang.String COPYRIGHT
Method Detail |
---|
void reportStart(com.ibm.are.core.Element elem)
elem
- The plugin that is startingvoid reportFinish(com.ibm.are.core.Element elem, ResultInfo result)
result
- The resultvoid reportStep(java.lang.String msg)
msg
- The message to reportvoid reportStepDetail(java.lang.String msg)
msg
- The message to reportvoid reportSubStep(java.lang.String msg)
msg
- The message to reportvoid reportSubStepDetail(java.lang.String msg)
msg
- The message to reportvoid reportStatistic(java.lang.String description, java.lang.Object value, int depth)
description
- A description of the statistic being reportedvalue
- The (statistic) value to reportdepth
- The depth in the status reporting hierarchy where the statistic will be reportedvoid report(java.lang.String msg, int depth)
msg
- The message to printdepth
- 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).
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |