com.ibm.are.plugin
Interface PluginReporting

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

public interface PluginReporting
extends StatusReporting

The PluginReporting interface defines the set of methods used for reporting problems in the ARE environment. The purpose of this interface is to define the set of problem reporting methods that plugin authors will have available to them via the BasePlugin class. Each reporting method returns a ProblemContext object. This object can be used to report any additional details about the problem by utilizing the ProblemContext.details(String) 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
 ProblemContext report(java.lang.String msg, java.lang.String errorLevel)
          Report a message at the given error level during the runtime processing.
 ProblemContext 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.
 ProblemContext reportError(java.lang.String msg)
          Report an error message during the runtime processing.
 ProblemContext 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.
 ProblemContext reportInfo(java.lang.String msg)
          Report an informational message during the runtime processing.
 ProblemContext 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.
 ProblemContext reportWarning(java.lang.String msg)
          Report a warning message during the runtime processing.
 ProblemContext 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.
 
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

reportInfo

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

Parameters:
msg - The message to print
Returns:
A context for the problem being reported. This context can be used to report additional details about the problem.

reportInfo

ProblemContext 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.
Returns:
A context for the problem being reported. This context can be used to report additional details about the problem.

reportWarning

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

Parameters:
msg - The message to print
Returns:
A context for the problem being reported. This context can be used to report additional details about the problem.

reportWarning

ProblemContext 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.
Returns:
A context for the problem being reported. This context can be used to report additional details about the problem.

reportError

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

Parameters:
msg - The message to print
Returns:
A context for the problem being reported. This context can be used to report additional details about the problem.

reportError

ProblemContext 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.
Returns:
A context for the problem being reported. This context can be used to report additional details about the problem.

report

ProblemContext 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
Returns:
A context for the problem being reported. This context can be used to report additional details about the problem.

report

ProblemContext 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.
Returns:
A context for the problem being reported. This context can be used to report additional details about the problem.