com.atlassian.jira.plugin.report

Interface ReportUrlProvider

@ExperimentalSpi
public interface ReportUrlProvider

Provides context-dependent URL for given report.

Since:

6.4

Method Summary

Modifier and Type	Method and Description
io.atlassian.fugue.Option<String>	getUrl(ReportModuleDescriptor reportModule, Map<String,Object> context) Generate Report URL for given ReportModuleDescriptor, within given context. When given context does not satisfy report requirements, or Report should not show in particular context, it should return Option.none()

Method Detail

getUrl

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

Generate Report URL for given ReportModuleDescriptor, within given context.
When given context does not satisfy report requirements, or Report should not show in particular context, it should return Option.none()

Parameters:

reportModule - Descriptor of Report Module which URL has to be generated

context - Context in which report will be displayed

Returns:

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