Summary: Methods | [Expand All]
@PublicSpi public interface

Report

com.atlassian.jira.plugin.report.Report
Known Indirect Subclasses

@PublicSpi

This interface is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

The interface for pluggable reports within JIRA.

See Also

Summary

Public Methods
String generateReportExcel(ProjectActionSupport action, Map params)
Generate the report's Excel HTML - usually from the Velocity resource named "excel".
String generateReportHtml(ProjectActionSupport action, Map params)
Generate the report's HTML - usually from the Velocity resource named "html".
void init(ReportModuleDescriptor reportModuleDescriptor)
Initialise this report, given the report's module descriptor.
boolean isExcelViewSupported()
Whether or not this report has an Excel view.
boolean showReport()
Whether or not to show this report at the current state of the system.
void validate(ProjectActionSupport action, Map params)
Validate the parameters passed to this report from the UI.

Public Methods

public String generateReportExcel (ProjectActionSupport action, Map params)

Generate the report's Excel HTML - usually from the Velocity resource named "excel".

Throws
Exception

public String generateReportHtml (ProjectActionSupport action, Map params)

Generate the report's HTML - usually from the Velocity resource named "html".

Throws
Exception

public void init (ReportModuleDescriptor reportModuleDescriptor)

Initialise this report, given the report's module descriptor.

This method is run immediately after the report is constructed.

public boolean isExcelViewSupported ()

Whether or not this report has an Excel view.

public boolean showReport ()

Whether or not to show this report at the current state of the system.

public 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.