Package com.axelor.report

Interface ReportConfigurer

All Known Implementing Classes:
ReportConfigurerImpl
public interface ReportConfigurer
Configures the reports generated by ReportGenerator.

Use it to apply application-specific behavior (timezone, render options, parameter validation...) to all generated reports.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    configure(org.eclipse.birt.report.engine.api.IRunAndRenderTask task, org.eclipse.birt.report.engine.api.IRenderOption options, Map<String,Object> params)
    Configures the task before it is run.
    void
    validate(org.eclipse.birt.report.engine.api.IReportRunnable report, Map<String,Object> params)
    Validates the report before it is rendered.

  • Method Details

    • validate

      void validate(org.eclipse.birt.report.engine.api.IReportRunnable report, Map<String,Object> params)
      Validates the report before it is rendered.

      Throw an exception to abort the report generation.

      Parameters:
      report - the opened report design
      params - the report parameters

    • configure

      void configure(org.eclipse.birt.report.engine.api.IRunAndRenderTask task, org.eclipse.birt.report.engine.api.IRenderOption options, Map<String,Object> params)
      Configures the task before it is run.

      The task locale, render option and parameter values are already set. Changing the task locale here overrides the one requested by the caller.

      Parameters:
      task - the task to run
      options - the task render option
      params - the report parameters