eu.geclipse.core.reporting
Interface IReportingService

public interface IReportingService

A reporting service provides both methods for querying the reporting mechanism for declarative problems and solutions and to for programmatically creating programs and solutions.

See Also:

ReportingPlugin.getReportingService()

Method Summary

IProblem	createProblem(java.lang.String description, java.lang.Throwable exception, java.lang.String mailto, java.lang.String pluginID) Programmatically create a problem from the specified description and exception.
ISolution	createSolution(java.lang.String description, ISolver solver) Programmatically create a solution from the specified description and solver.
IProblem	getProblem(java.lang.String problemID, java.lang.String description, java.lang.Throwable exception, java.lang.String pluginID) Get a problem that was declaratively defined via the eu.geclipse.core.reporting.problemReporting extension point.
ISolution	getSolution(java.lang.String solutionID, java.lang.String description) Get a solution that was declaratively defined via the eu.geclipse.core.reporting.problemReporting extension point.

Method Detail

createProblem

IProblem createProblem(java.lang.String description,
                       java.lang.Throwable exception,
                       java.lang.String mailto,
                       java.lang.String pluginID)

Programmatically create a problem from the specified description and exception. The IProblem.addReason(String) and IProblem.addSolution(ISolution)/IProblem.addSolution(String,String) may be used afterwards to further customize the problem.

Parameters:

description - A descriptive text that gives a short explanation of the problem.

exception - A Throwable that may have caused this problem. May be null.

mailto - An email-address that may be used to send an automated error report.

pluginID - The ID of the plug-in where the problem happened.

Returns:

The newly created problem. This problem will not be stored in the internal registry.

getProblem

IProblem getProblem(java.lang.String problemID,
                    java.lang.String description,
                    java.lang.Throwable exception,
                    java.lang.String pluginID)

Get a problem that was declaratively defined via the eu.geclipse.core.reporting.problemReporting extension point.

Parameters:

problemID - The unique ID of the problem as declared in the corresponding extension.

description - A descriptive text that overwrites the default text provided by the extension. If this is null the default text will be taken.

exception - A Throwable that may have caused this problem. May be null.

pluginID - The ID of the plug-in where the problem happened.

Returns:

The problem corresponding to the provided problem ID and modified with the specified description and exception. If no problem with the specified ID could be found a *unknown problem*-problem will be returned.

createSolution

ISolution createSolution(java.lang.String description,
                         ISolver solver)

Programmatically create a solution from the specified description and solver.

Parameters:

description - A descriptive text that gives a short explanation of the solution.

solver - An instance of the ISolver-interface that provides dedicated problem solving strategies. If this is null the solution will be passive.

Returns:

The newly created solution. This solution will not be stored in the internal registry.

getSolution

ISolution getSolution(java.lang.String solutionID,
                      java.lang.String description)

Get a solution that was declaratively defined via the eu.geclipse.core.reporting.problemReporting extension point.

Parameters:

solutionID - The unique ID of the solution as declared in the corresponding extension.

description - A descriptive text that overwrites the default text provided by the extension. If this is null the default text will be taken.

Returns:

The solution corresponding to the provided solution ID and modified with the specified description. If no problem with the specified ID could be found null will be returned.