|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PluginReporting
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.
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 |
---|
static final java.lang.String COPYRIGHT
Method Detail |
---|
ProblemContext reportInfo(java.lang.String msg)
msg
- The message to print
ProblemContext reportInfo(java.lang.String msg, com.ibm.are.autofix.FixAction fixAction)
msg
- The message to printfixAction
- The info about how to fix the problem.
ProblemContext reportWarning(java.lang.String msg)
msg
- The message to print
ProblemContext reportWarning(java.lang.String msg, com.ibm.are.autofix.FixAction fixAction)
msg
- The message to printfixAction
- The info about how to fix the problem.
ProblemContext reportError(java.lang.String msg)
msg
- The message to print
ProblemContext reportError(java.lang.String msg, com.ibm.are.autofix.FixAction fixAction)
msg
- The message to printfixAction
- The info about how to fix the problem.
ProblemContext report(java.lang.String msg, java.lang.String errorLevel)
msg
- The message to printerrorLevel
- The error level to use when reporting
ProblemContext report(java.lang.String msg, java.lang.String errorLevel, com.ibm.are.autofix.FixAction fixAction)
msg
- The message to printerrorLevel
- The error level to use when reportingfixAction
- The info about how to fix the problem.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |