com.canto.cumulus.server.esp.modules.reportgenerator

Interface ReportGeneratorESP

All Superinterfaces:

BaseESP

All Known Subinterfaces:

ReportGeneratorWebESP

public interface ReportGeneratorESP
extends BaseESP

Since:

8.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ReportGeneratorESP.ParameterKey

Method Summary

Methods

Modifier and Type	Method and Description
ReportGeneratorConfigurator	createConfigurator() This method is called by the Server Console "Reports" plugin to create a configurator for this report generator ESP.
ResultData2D	execute(JPack configurationData, java.util.Map<ReportGeneratorESP.ParameterKey,?> parameters) This method is called to create a ReportGenerator for the given configuration.
java.lang.String	getName(int language) Returns the name for this ReportGenerator ESP.
java.lang.Class	getResultClass(JPack configurationData, java.util.Map<ReportGeneratorESP.ParameterKey,?> parameters) Return the class object of the result data that will result from the given configuration.

Methods inherited from interface com.canto.cumulus.server.esp.modules.BaseESP

getID

Method Detail

getName

java.lang.String getName(int language)

Returns the name for this ReportGenerator ESP.

Parameters:

language - the language to get the name for

Returns:

the ReportGenerator ESPs name

createConfigurator

ReportGeneratorConfigurator createConfigurator()

This method is called by the Server Console "Reports" plugin to create a configurator for this report generator ESP.

Returns:

a configurator for this report generator ESP

getResultClass

java.lang.Class getResultClass(JPack configurationData,
                             java.util.Map<ReportGeneratorESP.ParameterKey,?> parameters)

Return the class object of the result data that will result from the given configuration.

Parameters:

configurationData - the configuration to be used when generating the report

parameters - a map of additional parameters, e.g. ReportGeneratorESP.ParameterKey.CUMULUS_SERVER to get the current com.canto.cumulus.Server object.

Returns:

The class of the result returned by this report generator ESP

execute

ResultData2D execute(JPack configurationData,
                   java.util.Map<ReportGeneratorESP.ParameterKey,?> parameters)

This method is called to create a ReportGenerator for the given configuration.

Parameters:

configurationData - the configuration to use for the report

parameters - a map of additional parameters, e.g. ReportGeneratorESP.ParameterKey.CUMULUS_SERVER to get the current com.canto.cumulus.Server object.

Returns:

the resulting report data to be displayed in a table