Package com.atlassian.jira.plugin.report

Interface Report

All Known Implementing Classes:
AbstractChartReport, AbstractReport, AverageAgeReport, CreatedVsResolvedReport, DeveloperWorkloadReport, FieldTestReport, PieReport, RecentlyCreatedReport, ReferenceReport, ResolutionTimeReport, SingleLevelGroupByReport, TimeSinceReport, TimeTrackingReport
@PublicSpi public interface Report
The interface for pluggable reports within JIRA.
See Also:

  • Method Details

    • init

      void init(ReportModuleDescriptor reportModuleDescriptor)
      Initialise this report, given the report's module descriptor.

      This method is run immediately after the report is constructed.

    • validate

      void validate(ProjectActionSupport action, Map params)
      Validate the parameters passed to this report from the UI.

      Any errors should be added to the action errors.

    • generateReportHtml

      String generateReportHtml(ProjectActionSupport action, Map params) throws Exception
      Generate the report's HTML - usually from the Velocity resource named "html".
      Throws:
      Exception

    • isExcelViewSupported

      boolean isExcelViewSupported()
      Whether or not this report has an Excel view.

    • generateReportExcel

      String generateReportExcel(ProjectActionSupport action, Map params) throws Exception
      Generate the report's Excel HTML - usually from the Velocity resource named "excel".
      Throws:
      Exception

    • showReport

      boolean showReport()
      Whether or not to show this report at the current state of the system.