com.ibm.are.report
Interface ReporterReporting

All Superinterfaces:
Reporting, StatusReporting
All Known Implementing Classes:
BasePlugin.ReporterCollection

public interface ReporterReporting
extends StatusReporting

The ReporterReporting interface defines the set of methods used for reporting problems in the ARE environment. Problems can be reported at three different severity levels: error, warning, or info. These differing levels give plugin authors the ability to assign a detected problem a level of severity, or put another way a level of importance, when reporting the problem.

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
 java.lang.Object getContents()
          Retrieves the entire contents of the report.
 int getOutputFormat()
          Retrieves the output format used for reporting
 com.ibm.are.report.Publisher publisher()
          The Publisher that is to be used when publishing this report.
 void report(java.lang.String msg, java.lang.String errorLevel)
          Report a message at the given error level during the runtime processing.
 void report(java.lang.String msg, java.lang.String errorLevel, com.ibm.are.autofix.FixAction fixAction)
          Report a message at the given error level during the runtime processing, with info about how to fix the problem.
 void reportDetail(ProblemContext problemCtx, java.lang.String msg, java.lang.String errorLevel)
          Report details for a problem at the given error level during the runtime processing.
 void reportError(java.lang.String msg)
          Report an error message during the runtime processing.
 void reportError(java.lang.String msg, com.ibm.are.autofix.FixAction fixAction)
          Report an error message during the runtime processing, with info about how to fix the problem.
 void reportErrorDetail(ProblemContext problemCtx, java.lang.String msg)
          Report details of an error message during the runtime processing.
 void reportInfo(java.lang.String msg)
          Report an informational message during the runtime processing.
 void reportInfo(java.lang.String msg, com.ibm.are.autofix.FixAction fixAction)
          Report an informational message during the runtime processing, with info about how to fix the problem.
 void reportInfoDetail(ProblemContext problemCtx, java.lang.String msg)
          Report details for an informational message during the runtime processing.
 void reportWarning(java.lang.String msg)
          Report a warning message during the runtime processing.
 void reportWarning(java.lang.String msg, com.ibm.are.autofix.FixAction fixAction)
          Report a warning message during the runtime processing, with info about how to fix the problem.
 void reportWarningDetail(ProblemContext problemCtx, java.lang.String msg)
          Report details for a warning message during the runtime processing.
 
Methods inherited from interface com.ibm.are.report.StatusReporting
report, reportFinish, reportStart, reportStatistic, reportStep, reportStepDetail, reportSubStep, reportSubStepDetail
 

Field Detail

COPYRIGHT

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

See Also:
Constant Field Values
Method Detail

getOutputFormat

int getOutputFormat()
Retrieves the output format used for reporting

Returns:
The output format

reportInfo

void reportInfo(java.lang.String msg)
Report an informational message during the runtime processing.

Parameters:
msg - The message to print

reportInfo

void reportInfo(java.lang.String msg,
                com.ibm.are.autofix.FixAction fixAction)
Report an informational message during the runtime processing, with info about how to fix the problem.

Parameters:
msg - The message to print
fixAction - The info about how to fix the problem.

reportWarning

void reportWarning(java.lang.String msg)
Report a warning message during the runtime processing.

Parameters:
msg - The message to print

reportWarning

void reportWarning(java.lang.String msg,
                   com.ibm.are.autofix.FixAction fixAction)
Report a warning message during the runtime processing, with info about how to fix the problem.

Parameters:
msg - The message to print
fixAction - The info about how to fix the problem.

reportError

void reportError(java.lang.String msg)
Report an error message during the runtime processing.

Parameters:
msg - The message to print

reportError

void reportError(java.lang.String msg,
                 com.ibm.are.autofix.FixAction fixAction)
Report an error message during the runtime processing, with info about how to fix the problem.

Parameters:
msg - The message to print
fixAction - The info about how to fix the problem.

report

void report(java.lang.String msg,
            java.lang.String errorLevel)
Report a message at the given error level during the runtime processing.

Parameters:
msg - The message to print
errorLevel - The error level to use when reporting

report

void report(java.lang.String msg,
            java.lang.String errorLevel,
            com.ibm.are.autofix.FixAction fixAction)
Report a message at the given error level during the runtime processing, with info about how to fix the problem.

Parameters:
msg - The message to print
errorLevel - The error level to use when reporting
fixAction - The info about how to fix the problem.

reportInfoDetail

void reportInfoDetail(ProblemContext problemCtx,
                      java.lang.String msg)
Report details for an informational message during the runtime processing.

Parameters:
msg - The message to print
problemCtx - The context of the problem for which the details are being reported.

reportWarningDetail

void reportWarningDetail(ProblemContext problemCtx,
                         java.lang.String msg)
Report details for a warning message during the runtime processing.

Parameters:
msg - The message to print
problemCtx - The context of the problem for which the details are being reported.

reportErrorDetail

void reportErrorDetail(ProblemContext problemCtx,
                       java.lang.String msg)
Report details of an error message during the runtime processing.

Parameters:
problemCtx - The context of the problem for which the details are being reported.
msg - The message to print

reportDetail

void reportDetail(ProblemContext problemCtx,
                  java.lang.String msg,
                  java.lang.String errorLevel)
Report details for a problem at the given error level during the runtime processing.

Parameters:
problemCtx - The context of the problem for which the details are being reported.
msg - The message to print
errorLevel - The error level to use when reporting

getContents

java.lang.Object getContents()
Retrieves the entire contents of the report. The object that represents the contents can be anything; a String, a Document, etc. It is the responsibility of the invoker of this method to properly determine the type of object returned before performing any operations against it.

Returns:
The entire contents of the report

publisher

com.ibm.are.report.Publisher publisher()
The Publisher that is to be used when publishing this report.

Returns:
The publisher to use