com.atlassian.jira.plugin.report
Interface Report

All Known Implementing Classes:

AbstractReport

public interface Report

The interface for pluggable reports within JIRA.

See Also:

AbstractReport, ReportModuleDescriptor

Method Summary

java.lang.String	generateReportExcel(ProjectActionSupport action, java.util.Map params) Generate the report's Excel HTML - usually from the Velocity resource named "excel".
java.lang.String	generateReportHtml(ProjectActionSupport action, java.util.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, java.util.Map params) Validate the parameters passed to this report from the UI.

Method Detail

init

public void init(ReportModuleDescriptor reportModuleDescriptor)

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

This method is run immediately after the report is constructed.

validate

public void validate(ProjectActionSupport action,
                     java.util.Map params)

Validate the parameters passed to this report from the UI.

Any errors should be added to the action errors.

generateReportHtml

public java.lang.String generateReportHtml(ProjectActionSupport action,
                                           java.util.Map params)
                                    throws java.lang.Exception

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

Throws:

java.lang.Exception

isExcelViewSupported

public boolean isExcelViewSupported()

Whether or not this report has an Excel view.

generateReportExcel

public java.lang.String generateReportExcel(ProjectActionSupport action,
                                            java.util.Map params)
                                     throws java.lang.Exception

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

Throws:

java.lang.Exception

showReport

public boolean showReport()

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