public interface

ReportModuleDescriptor

implements ConfigurableModuleDescriptor JiraResourcedModuleDescriptor<T> WeightedDescriptor
com.atlassian.jira.plugin.report.ReportModuleDescriptor
Known Indirect Subclasses

Class Overview

The report plugin allows end users to write pluggable reports for JIRA.

See Also

Summary

Public Methods
ReportCategory getCategory()
Returns the report category.
String getLabel()
String getLabelKey()
Report getModule()
String getThumbnailCssClass()
Returns the class which will be used to decorate report thumbnail
String getUrl(Project project)
Returns url for first page of this report.
@ExperimentalApi Option<String> getUrl(Map<String, Object> context)
Returns optional URL for the first page of this report within specified context.
[Expand]
Inherited Methods
From interface com.atlassian.jira.plugin.ConfigurableModuleDescriptor
From interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced
From interface com.atlassian.plugin.web.descriptors.WeightedDescriptor

Public Methods

public ReportCategory getCategory ()

Returns the report category. Should not be null.

Returns
  • the report category

public String getLabel ()

public String getLabelKey ()

public Report getModule ()

public String getThumbnailCssClass ()

Returns the class which will be used to decorate report thumbnail

Returns
  • css class

public String getUrl (Project project)

Returns url for first page of this report. Project parameter is provided to insert context into the URL

Parameters
project project in which context this report is opened
Returns
  • url for the first page of this report

@ExperimentalApi public Option<String> getUrl (Map<String, Object> context)

@ExperimentalApi

This method is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

Returns optional URL for the first page of this report within specified context. none() means the report should not show in this particular context.

Parameters
context context in which this report is opened
Returns
  • Report URL or none() when report should not show in this context