@PublicSpi public abstract class

AbstractReport

extends Object
implements Report

java.lang.Object
↳	com.atlassian.jira.plugin.report.impl.AbstractReport

Known Direct Subclasses

AbstractChartReport, DeveloperWorkloadReport, ReferenceReport, SingleLevelGroupByReport, TimeTrackingReport

Known Indirect Subclasses

AverageAgeReport, CreatedVsResolvedReport, PieReport, RecentlyCreatedReport, ResolutionTimeReport, TimeSinceReport

@PublicSpi

This class 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).

Summary

Nested Classes
class	AbstractReport.MutableLong	This utility class is much like an AtomicLong, but it does not have the thread-safety guarantees and overhead of that class.

Fields
protected ReportModuleDescriptor	descriptor

Public Constructors
	AbstractReport()

Public Methods
String	generateReportExcel(ProjectActionSupport action, Map params) By default, will throw an UnsuppportedOperationException as reports don't support Excel by default.
IssueConstant	getIssueConstant(GenericValue issueConstantGV)
void	init(ReportModuleDescriptor descriptor) Initialise this report, given the report's module descriptor.
boolean	isExcelViewSupported() By default, reports do not have an Excel view.
boolean	showReport() Whether or not to show this report in the interface.
void	validate(ProjectActionSupport action, Map params) Validate the parameters passed to this report from the UI.

Protected Methods
ReportModuleDescriptor	getDescriptor()

[Expand]

Inherited Methods

From class java.lang.Object

From interface com.atlassian.jira.plugin.report.Report

Fields

protected ReportModuleDescriptor descriptor

Public Constructors

public AbstractReport ()

Public Methods

public String generateReportExcel (ProjectActionSupport action, Map params)

By default, will throw an UnsuppportedOperationException as reports don't support Excel by default.

Throws

Exception

public IssueConstant getIssueConstant (GenericValue issueConstantGV)

public void init (ReportModuleDescriptor descriptor)

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

This method is run immediately after the report is constructed.

public boolean isExcelViewSupported ()

By default, reports do not have an Excel view.

public boolean showReport ()

Whether or not to show this report in the interface. The default is "true".

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.

Interfaces

Classes