public interface Report
One report generated from the underlying model.
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic enum
The column alignments.static interface
One column within a report result.static interface
A single parameter sent to the report query.static interface
A single result of a report query. -
Method Summary
Modifier and TypeMethodDescriptionexecuteReport
(Map<String, ? extends Object> parameterValues) Executes the report and gets the results.Gets a description of this report in the user locale.getDescription
(Map<String, ? extends Object> parameterValues) Gets a description of this report in the user locale with the provided parameters.getName()
Gets the constant name of this report.Iterable
<? extends Report.Parameter> Gets the set of parameters that this report requires.getTitle()
Gets a display title of this report in the user locale.Gets a display title of this report in the user locale with the provided parameters.
-
Method Details
-
getName
String getName()Gets the constant name of this report. -
getTitle
String getTitle()Gets a display title of this report in the user locale. -
getTitle
Gets a display title of this report in the user locale with the provided parameters. -
getDescription
String getDescription()Gets a description of this report in the user locale. -
getDescription
Gets a description of this report in the user locale with the provided parameters. -
getParameters
Iterable<? extends Report.Parameter> getParameters()Gets the set of parameters that this report requires. -
executeReport
Executes the report and gets the results.- Throws:
SQLException
-