com.aoindustries.dao

Interface Report

public interface Report

One report generated from the underlying model.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Report.Alignment
static interface	Report.Column
static interface	Report.Parameter
static interface	Report.Result

Method Summary

Modifier and Type	Method and Description
Report.Result	executeReport(Map<String,? extends Object> parameterValues) Executes the report and gets the results.
String	getDescription() Gets a description of this report in the user locale.
String	getDescription(Map<String,? extends Object> parameterValues) Gets a description of this report in the user locale with the provided parameters.
String	getName() Gets the constant name of this report.
Iterable<? extends Report.Parameter>	getParameters() Gets the set of parameters that this report requires.
String	getTitle() Gets a display title of this report in the user locale.
String	getTitle(Map<String,? extends Object> parameterValues) Gets a display title of this report in the user locale with the provided parameters.

Method Detail

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

String getTitle(Map<String,? extends Object> parameterValues)

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

String getDescription(Map<String,? extends Object> parameterValues)

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

Report.Result executeReport(Map<String,? extends Object> parameterValues)
                     throws SQLException

Executes the report and gets the results.

Throws:

SQLException