com.atlassian.jira.plugin.report
Class ReportModuleDescriptorImpl

java.lang.Object
  com.atlassian.plugin.descriptors.AbstractModuleDescriptor<T>
      com.atlassian.jira.plugin.AbstractJiraModuleDescriptor<T>
          com.atlassian.jira.plugin.AbstractConfigurableModuleDescriptor<Report>
              com.atlassian.jira.plugin.report.ReportModuleDescriptorImpl

All Implemented Interfaces:

ConfigurableModuleDescriptor, JiraResourcedModuleDescriptor<Report>, ReportModuleDescriptor, com.atlassian.plugin.ModuleDescriptor<Report>, com.atlassian.plugin.Resourced, com.atlassian.plugin.StateAware

public class ReportModuleDescriptorImpl
extends AbstractConfigurableModuleDescriptor<Report>
implements ReportModuleDescriptor

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

See Also:

Report

Field Summary

static String

PARAMS_PATTERN

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources, singleton

Constructor Summary

ReportModuleDescriptorImpl(JiraAuthenticationContext authenticationContext, com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Summary

void	enabled()
String	getLabel()
String	getLabelKey()
Report	getModule()
String	getUrl(Project project) Returns url for first page of this report.
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
protected boolean	isSingletonByDefault()

Methods inherited from class com.atlassian.jira.plugin.AbstractConfigurableModuleDescriptor

disabled, getObjectConfiguration, getObjectDescriptor

Methods inherited from class com.atlassian.jira.plugin.AbstractJiraModuleDescriptor

assertResourceExists, createModule, createVelocityParams, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getName, getText, getText, isResourceExist, writeHtml

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, destroy, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, isEnabledByDefault, isSingleton, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getHtml, getHtml, getI18nBean, writeHtml

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

destroy, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion

Methods inherited from interface com.atlassian.plugin.Resourced

getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation

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

getObjectConfiguration

Field Detail

PARAMS_PATTERN

public static final String PARAMS_PATTERN

See Also:

Constant Field Values

Constructor Detail

ReportModuleDescriptorImpl

public ReportModuleDescriptorImpl(JiraAuthenticationContext authenticationContext,
                                  com.atlassian.plugin.module.ModuleFactory moduleFactory)

Method Detail

isSingletonByDefault

protected boolean isSingletonByDefault()

Overrides:

isSingletonByDefault in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Report>

init

public void init(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

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

Overrides:

init in class AbstractConfigurableModuleDescriptor<Report>

Throws:

com.atlassian.plugin.PluginParseException

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class AbstractConfigurableModuleDescriptor<Report>

getModule

public Report getModule()

Specified by:

getModule in interface ReportModuleDescriptor

Specified by:

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

Overrides:

getModule in class AbstractJiraModuleDescriptor<Report>

getLabel

public String getLabel()

Specified by:

getLabel in interface ReportModuleDescriptor

getLabelKey

public String getLabelKey()

Specified by:

getLabelKey in interface ReportModuleDescriptor

getUrl

public String getUrl(Project project)

Description copied from interface: ReportModuleDescriptor

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

Specified by:

getUrl in interface ReportModuleDescriptor

Parameters:

project - project in which context this report is opened

Returns:

url for the first page of this report