com.atlassian.jira.plugin.report

Interface ReportModuleDescriptor

All Superinterfaces:

ConfigurableModuleDescriptor, JiraResourcedModuleDescriptor<Report>, com.atlassian.plugin.ModuleDescriptor<Report>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.web.descriptors.WeightedDescriptor

All Known Implementing Classes:

ReportModuleDescriptorImpl

public interface ReportModuleDescriptor
extends JiraResourcedModuleDescriptor<Report>, ConfigurableModuleDescriptor, com.atlassian.plugin.web.descriptors.WeightedDescriptor

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

See Also:

Report

Method Summary

Modifier and Type	Method and Description
ReportCategory	getCategory() Returns the report category.
Optional<String>	getConfigurationRemarks() Returns an optional string to display as an informative remark on report configuration page
Optional<String>	getConfigurationRemarksHeader() Returns an optional string to display as the header for an informative remark on report configuration page
String	getLabel()
String	getLabelKey()
Optional<String>	getLearnMoreLinkURL() Returns an optional URL to display as the "Learn more" link on the informative remark on report configuration page
Report	getModule()
String	getThumbnailCssClass() Returns the class which will be used to decorate report thumbnail
io.atlassian.fugue.Option<String>	getUrl(Map<String,Object> context) Returns optional URL for the first page of this report within specified context.
String	getUrl(Project project) Returns url for first page of this report.

Methods inherited from interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor

getHtml, getHtml, getI18nBean, writeHtml

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

Methods inherited from interface com.atlassian.plugin.ScopeAware

getScopeKey

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceLocation

Methods inherited from interface com.atlassian.jira.plugin.ConfigurableModuleDescriptor

getObjectConfiguration

Methods inherited from interface com.atlassian.plugin.web.descriptors.WeightedDescriptor

getWeight

Method Detail

getModule

Report getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<Report>

getLabel

String getLabel()

getLabelKey

String getLabelKey()

getUrl

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

Since:

6.2

getUrl

@ExperimentalApi
io.atlassian.fugue.Option<String> getUrl(Map<String,Object> context)

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 Option.none() when report should not show in this context

Since:

6.4

getCategory

ReportCategory getCategory()

Returns the report category. Should not be null.

Returns:

the report category

Since:

6.4

getThumbnailCssClass

String getThumbnailCssClass()

Returns the class which will be used to decorate report thumbnail

Returns:

css class

Since:

6.4

getConfigurationRemarks

Optional<String> getConfigurationRemarks()

Returns an optional string to display as an informative remark on report configuration page

Returns:

a string representing configuration remarks

Since:

8.5.12

getConfigurationRemarksHeader

Optional<String> getConfigurationRemarksHeader()

Returns an optional string to display as the header for an informative remark on report configuration page

Returns:

a string representing configuration remarks header

Since:

8.5.12

getLearnMoreLinkURL

Optional<String> getLearnMoreLinkURL()

Returns an optional URL to display as the "Learn more" link on the informative remark on report configuration page

Returns:

a string representing of the "Learn more" URL

Since:

8.5.12