public interface ReportModuleDescriptor extends JiraResourcedModuleDescriptor<Report>, ConfigurableModuleDescriptor, com.atlassian.plugin.web.descriptors.WeightedDescriptor
Report
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.
|
getHtml, getHtml, getI18nBean, writeHtml
destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken
getResourceDescriptor, getResourceDescriptors, getResourceLocation
getObjectConfiguration
Report getModule()
getModule
in interface com.atlassian.plugin.ModuleDescriptor<Report>
String getLabel()
String getLabelKey()
String getUrl(Project project)
project
- project in which context this report is opened@ExperimentalApi io.atlassian.fugue.Option<String> getUrl(Map<String,Object> context)
none()
means the report should not show in this particular context.context
- context in which this report is openedOption.none()
when report should not show in this contextReportCategory getCategory()
String getThumbnailCssClass()
Optional<String> getConfigurationRemarks()
Optional<String> getConfigurationRemarksHeader()
Copyright © 2002-2022 Atlassian. All Rights Reserved.