Package org.nuclos.api.provider

Class ReportProvider

java.lang.Object

org.nuclos.api.provider.ReportProvider

public class ReportProvider
extends Object

ReportProvider provides methods for executing reports

This Class is usually used in Rule-classes and allows API access only

Author:

Matthias Reichart

Constructor Summary

Constructors

Constructor	Description
ReportProvider()

Method Summary

Modifier and Type	Method	Description
static NuclosFile	run(OutputFormat format)	This method runs the Report that belongs to the given OutputFormat and returns the generated NuclosFile
static NuclosFile	run(OutputFormat format, Map<String,Object> params)	Providing the parameters this method runs the Report that belongs to the given OutputFormat and returns the generated NuclosFile
static NuclosFile	run(OutputFormat format, Map<String,Object> params, NuclosLocale locale)	Providing the parameters this method runs the Report that belongs to the given OutputFormat and returns the generated NuclosFile containing all localized data in the given locale language
static NuclosFile	run(OutputFormat format, NuclosLocale locale)	This method runs the Report that belongs to the given OutputFormat and returns the generated NuclosFile containing all localized data in the given locale language
static NuclosFile	run(UID outputFormatId, Map<String,Object> params, NuclosLocale locale)
void	setReportService(ReportService repService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ReportProvider

public ReportProvider()

Method Details

setReportService

public void setReportService(ReportService repService)

run

public static NuclosFile run(OutputFormat format)
                      throws BusinessException

This method runs the Report that belongs to the given OutputFormat and returns the generated NuclosFile

Parameters:

format - OutputFormat - ReportOutputFormat stored in the generated report class

Returns:

NuclosFile

Throws:

BusinessException

run

public static NuclosFile run(OutputFormat format,
 Map<String,Object> params)
                      throws BusinessException

Providing the parameters this method runs the Report that belongs to the given OutputFormat and returns the generated NuclosFile

Parameters:

format - OutputFormat - ReportOutputFormat stored in the generated report class

params - Map - Parameters for the report

Returns:

NuclosFile

Throws:

BusinessException

run

public static NuclosFile run(OutputFormat format,
 NuclosLocale locale)
                      throws BusinessException

This method runs the Report that belongs to the given OutputFormat and returns the generated NuclosFile containing all localized data in the given locale language

Parameters:

format - OutputFormat - ReportOutputFormat stored in the generated report class

locale - NuclosLocale - Data locale

Returns:

NuclosFile

Throws:

BusinessException

run

public static NuclosFile run(OutputFormat format,
 Map<String,Object> params,
 NuclosLocale locale)
                      throws BusinessException

Providing the parameters this method runs the Report that belongs to the given OutputFormat and returns the generated NuclosFile containing all localized data in the given locale language

Parameters:

format - OutputFormat - ReportOutputFormat stored in the generated report class

params - Map - Parameters for the report

locale - NuclosLocale - Data locale

Returns:

NuclosFile

Throws:

BusinessException

run

public static NuclosFile run(UID outputFormatId,
 Map<String,Object> params,
 NuclosLocale locale)
                      throws BusinessException

Throws:

BusinessException