public class

ReportModuleDescriptorImpl

extends AbstractConfigurableModuleDescriptor<T>
implements ReportModuleDescriptor ConditionalDescriptor
java.lang.Object
   ↳ com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
     ↳ com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<T>
       ↳ com.atlassian.jira.plugin.AbstractConfigurableModuleDescriptor<T>
         ↳ com.atlassian.jira.plugin.report.ReportModuleDescriptorImpl

Class Overview

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

See Also

Summary

Constants
String DEFAULT_THUMBNAIL_CSS_CLASS
int DEFAULT_WEIGHT
String PARAMS_PATTERN
[Expand]
Inherited Fields
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
Public Constructors
@Deprecated ReportModuleDescriptorImpl(JiraAuthenticationContext authenticationContext, ModuleFactory moduleFactory)
ReportModuleDescriptorImpl(JiraAuthenticationContext authenticationContext, ModuleFactory moduleFactory, ConditionDescriptorFactory conditionDescFactory)
Public Methods
void enabled()
ReportCategory getCategory()
Returns the report category.
Condition getCondition()
String getLabel()
String getLabelKey()
Report getModule()
String getThumbnailCssClass()
Returns the class which will be used to decorate report thumbnail
String getUrl(Project context)
Returns url for first page of this report.
Option<String> getUrl(Map<String, Object> context)
Returns optional URL for the first page of this report within specified context.
int getWeight()
void init(Plugin plugin, Element element)
Protected Methods
boolean isSingletonByDefault()
[Expand]
Inherited Methods
From class com.atlassian.jira.plugin.AbstractConfigurableModuleDescriptor
From class com.atlassian.jira.plugin.AbstractJiraModuleDescriptor
From class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
From class java.lang.Object
From interface com.atlassian.jira.plugin.ConfigurableModuleDescriptor
From interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor
From interface com.atlassian.jira.plugin.report.ReportModuleDescriptor
From interface com.atlassian.plugin.ModuleDescriptor
From interface com.atlassian.plugin.Resourced
From interface com.atlassian.plugin.StateAware
From interface com.atlassian.plugin.web.descriptors.ConditionalDescriptor
From interface com.atlassian.plugin.web.descriptors.WeightedDescriptor

Constants

public static final String DEFAULT_THUMBNAIL_CSS_CLASS

Constant Value: "default-thumbnail"

public static final int DEFAULT_WEIGHT

Constant Value: 1000 (0x000003e8)

public static final String PARAMS_PATTERN

Constant Value: "{0}?selectedProjectId={1,number,#}&projectOrFilterId=project-{1,number,#}&projectOrFilterName={2}&reportKey={3}"

Public Constructors

@Deprecated public ReportModuleDescriptorImpl (JiraAuthenticationContext authenticationContext, ModuleFactory moduleFactory)

public ReportModuleDescriptorImpl (JiraAuthenticationContext authenticationContext, ModuleFactory moduleFactory, ConditionDescriptorFactory conditionDescFactory)

Public Methods

public void enabled ()

public ReportCategory getCategory ()

Returns the report category. Should not be null.

Returns
  • the report category

public Condition getCondition ()

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 context)

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

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

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

public int getWeight ()

public void init (Plugin plugin, Element element)

Throws
PluginParseException

Protected Methods

protected boolean isSingletonByDefault ()