public class ReportModuleDescriptorImpl extends AbstractConfigurableModuleDescriptor<Report> implements ReportModuleDescriptor, com.atlassian.plugin.web.descriptors.ConditionalDescriptor
Report
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_THUMBNAIL_CSS_CLASS |
static int |
DEFAULT_WEIGHT |
static String |
PARAMS_PATTERN |
Constructor and Description |
---|
ReportModuleDescriptorImpl(JiraAuthenticationContext authenticationContext,
com.atlassian.plugin.module.ModuleFactory moduleFactory)
Deprecated.
|
ReportModuleDescriptorImpl(JiraAuthenticationContext authenticationContext,
com.atlassian.plugin.module.ModuleFactory moduleFactory,
ConditionDescriptorFactory conditionDescFactory) |
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() |
disabled, getObjectConfiguration, getObjectDescriptor
assertResourceExists, createModule, createVelocityParams, getAuthenticationContext, getClassLoader, getDescription, getHtml, getHtml, getI18nBean, getName, getText, getText, isResourceExist, writeHtml
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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getHtml, getHtml, getI18nBean, writeHtml
destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken
getResourceDescriptor, getResourceDescriptors, getResourceLocation
getObjectConfiguration
public static final String PARAMS_PATTERN
public static final int DEFAULT_WEIGHT
public static final String DEFAULT_THUMBNAIL_CSS_CLASS
@Deprecated public ReportModuleDescriptorImpl(JiraAuthenticationContext authenticationContext, com.atlassian.plugin.module.ModuleFactory moduleFactory)
public ReportModuleDescriptorImpl(JiraAuthenticationContext authenticationContext, com.atlassian.plugin.module.ModuleFactory moduleFactory, ConditionDescriptorFactory conditionDescFactory)
protected boolean isSingletonByDefault()
public void init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element) throws com.atlassian.plugin.PluginParseException
init
in interface com.atlassian.plugin.ModuleDescriptor<Report>
init
in class AbstractConfigurableModuleDescriptor<Report>
com.atlassian.plugin.PluginParseException
public void enabled()
enabled
in interface com.atlassian.plugin.StateAware
enabled
in class AbstractConfigurableModuleDescriptor<Report>
public Report getModule()
getModule
in interface ReportModuleDescriptor
getModule
in interface com.atlassian.plugin.ModuleDescriptor<Report>
getModule
in class AbstractJiraModuleDescriptor<Report>
public boolean isSingleton()
public String getLabel()
getLabel
in interface ReportModuleDescriptor
public String getLabelKey()
getLabelKey
in interface ReportModuleDescriptor
public String getUrl(Project context)
ReportModuleDescriptor
getUrl
in interface ReportModuleDescriptor
context
- project in which context this report is openedpublic io.atlassian.fugue.Option<String> getUrl(Map<String,Object> context)
ReportModuleDescriptor
none()
means the report should not show in this particular context.getUrl
in interface ReportModuleDescriptor
context
- context in which this report is openedOption.none()
when report should not show in this contextpublic ReportCategory getCategory()
ReportModuleDescriptor
getCategory
in interface ReportModuleDescriptor
public String getThumbnailCssClass()
ReportModuleDescriptor
getThumbnailCssClass
in interface ReportModuleDescriptor
public Optional<String> getConfigurationRemarks()
ReportModuleDescriptor
getConfigurationRemarks
in interface ReportModuleDescriptor
public Optional<String> getConfigurationRemarksHeader()
ReportModuleDescriptor
getConfigurationRemarksHeader
in interface ReportModuleDescriptor
public Optional<String> getLearnMoreLinkURL()
ReportModuleDescriptor
getLearnMoreLinkURL
in interface ReportModuleDescriptor
public int getWeight()
getWeight
in interface com.atlassian.plugin.web.descriptors.WeightedDescriptor
public com.atlassian.plugin.web.Condition getCondition()
getCondition
in interface com.atlassian.plugin.web.descriptors.ConditionalDescriptor
Copyright © 2002-2023 Atlassian. All Rights Reserved.