Module com.aoapps.dao.api

Package com.aoapps.dao

Interface Report

public interface Report

One report generated from the underlying model.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Report.Alignment	The column alignments.
static interface	Report.Column	One column within a report result.
static interface	Report.Parameter	A single parameter sent to the report query.
static interface	Report.Result	A single result of a report query.

Method Summary

Modifier and Type	Method	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 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

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