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.ScopeAware, com.atlassian.plugin.StateAware, com.atlassian.plugin.web.descriptors.ConditionalDescriptor, com.atlassian.plugin.web.descriptors.WeightedDescriptor

public class ReportModuleDescriptorImpl
extends AbstractConfigurableModuleDescriptor<Report>
implements ReportModuleDescriptor, com.atlassian.plugin.web.descriptors.ConditionalDescriptor

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

See Also:

Report

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_THUMBNAIL_CSS_CLASS
static int	DEFAULT_WEIGHT
static String	PARAMS_PATTERN

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

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

Constructor Summary

Constructors

Constructor and Description
ReportModuleDescriptorImpl(JiraAuthenticationContext authenticationContext, com.atlassian.plugin.module.ModuleFactory moduleFactory) Deprecated.
ReportModuleDescriptorImpl(JiraAuthenticationContext authenticationContext, com.atlassian.plugin.module.ModuleFactory moduleFactory, ConditionDescriptorFactory conditionDescFactory)

Method Summary

Modifier and Type	Method and Description
void	enabled()
ReportCategory	getCategory() Returns the report category.
com.atlassian.plugin.web.Condition	getCondition()
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 context) Returns url for first page of this report.
int	getWeight()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
boolean	isSingleton()
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, equals, getCompleteKey, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, 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, equals, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, 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

Field Detail

PARAMS_PATTERN

public static final String PARAMS_PATTERN

See Also:

Constant Field Values

DEFAULT_WEIGHT

public static final int DEFAULT_WEIGHT

See Also:

Constant Field Values

DEFAULT_THUMBNAIL_CSS_CLASS

public static final String DEFAULT_THUMBNAIL_CSS_CLASS

See Also:

Constant Field Values

Constructor Detail

ReportModuleDescriptorImpl

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

Deprecated.

ReportModuleDescriptorImpl

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

Method Detail

isSingletonByDefault

protected boolean isSingletonByDefault()

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>

isSingleton

public boolean isSingleton()

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

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:

context - project in which context this report is opened

Returns:

url for the first page of this report

getUrl

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

Description copied from interface: ReportModuleDescriptor

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

Specified by:

getUrl in interface ReportModuleDescriptor

Parameters:

context - context in which this report is opened

Returns:

Report URL or Option.none() when report should not show in this context

getCategory

public ReportCategory getCategory()

Description copied from interface: ReportModuleDescriptor

Returns the report category. Should not be null.

Specified by:

getCategory in interface ReportModuleDescriptor

Returns:

the report category

getThumbnailCssClass

public String getThumbnailCssClass()

Description copied from interface: ReportModuleDescriptor

Returns the class which will be used to decorate report thumbnail

Specified by:

getThumbnailCssClass in interface ReportModuleDescriptor

Returns:

css class

getConfigurationRemarks

public Optional<String> getConfigurationRemarks()

Description copied from interface: ReportModuleDescriptor

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

Specified by:

getConfigurationRemarks in interface ReportModuleDescriptor

Returns:

a string representing configuration remarks

getConfigurationRemarksHeader

public Optional<String> getConfigurationRemarksHeader()

Description copied from interface: ReportModuleDescriptor

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

Specified by:

getConfigurationRemarksHeader in interface ReportModuleDescriptor

Returns:

a string representing configuration remarks header

getLearnMoreLinkURL

public Optional<String> getLearnMoreLinkURL()

Description copied from interface: ReportModuleDescriptor

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

Specified by:

getLearnMoreLinkURL in interface ReportModuleDescriptor

Returns:

a string representing of the "Learn more" URL

getWeight

public int getWeight()

Specified by:

getWeight in interface com.atlassian.plugin.web.descriptors.WeightedDescriptor

getCondition

public com.atlassian.plugin.web.Condition getCondition()

Specified by:

getCondition in interface com.atlassian.plugin.web.descriptors.ConditionalDescriptor