Package io.jmix.reportsflowui.runner

Class DefaultReportExecutionPresentation

java.lang.Object

io.jmix.reportsflowui.runner.DefaultReportExecutionPresentation

All Implemented Interfaces:

ReportExecutionPresentation

@NullMarked
@Component("report_DefaultReportExecutionPresentation")
public class DefaultReportExecutionPresentation
extends Object
implements ReportExecutionPresentation

Constructor Summary

Constructors

Constructor	Description
DefaultReportExecutionPresentation()

Method Summary

Modifier and Type	Method	Description
List<ReportOutputType>	getAvailableOutputTypes(@Nullable Report report, @Nullable ReportTemplate template)
List<ReportTemplate>	getAvailableTemplates(@Nullable Report report)
String	getId()
boolean	requiresUserChoice(@Nullable Report report, @Nullable ReportTemplate selectedTemplate, @Nullable ReportOutputType selectedOutputType)	A selection passed in the arguments does not automatically remove the need to ask: the built-in presentations still let the user choose between several compatible templates, but do not ask for an output type that has already been chosen.
@Nullable ReportOutputType	resolveDefaultOutputType(@Nullable Report report, @Nullable ReportTemplate template, @Nullable ReportOutputType selectedOutputType)	Resolves the output type to run the report with.
@Nullable ReportTemplate	resolveDefaultTemplate(@Nullable Report report, @Nullable ReportTemplate selectedTemplate)
boolean	supportsReport(@Nullable Report report)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultReportExecutionPresentation

public DefaultReportExecutionPresentation()

Method Details

getId

public String getId()

Specified by:

getId in interface ReportExecutionPresentation

Returns:

unique identifier of this presentation (see ReportExecutionPresentationIds)

supportsReport

public boolean supportsReport(@Nullable Report report)

Specified by:

supportsReport in interface ReportExecutionPresentation

Returns:

true if the report has at least one template and output type compatible with this presentation

getAvailableTemplates

public List<ReportTemplate> getAvailableTemplates(@Nullable Report report)

Specified by:

getAvailableTemplates in interface ReportExecutionPresentation

Returns:

templates of the report that are compatible with this presentation

resolveDefaultTemplate

public @Nullable ReportTemplate resolveDefaultTemplate(@Nullable Report report,
 @Nullable ReportTemplate selectedTemplate)

Specified by:

resolveDefaultTemplate in interface ReportExecutionPresentation

Returns:

the template that should be used by default for this presentation, preferring selectedTemplate if it is compatible

getAvailableOutputTypes

public List<ReportOutputType> getAvailableOutputTypes(@Nullable Report report,
 @Nullable ReportTemplate template)

Specified by:

getAvailableOutputTypes in interface ReportExecutionPresentation

Returns:

output types for the template that are compatible with this presentation

resolveDefaultOutputType

public @Nullable ReportOutputType resolveDefaultOutputType(@Nullable Report report,
 @Nullable ReportTemplate template,
 @Nullable ReportOutputType selectedOutputType)

Description copied from interface: ReportExecutionPresentation

Resolves the output type to run the report with.

An explicitly requested selectedOutputType, e.g. the one set through the report runner API, must not be silently replaced: an implementation may return another type only if the requested one cannot be produced, either because this presentation is unable to render it or because the template cannot be converted to it. Restrictions on what the user is allowed to choose belong to ReportExecutionPresentation.getAvailableOutputTypes(Report, ReportTemplate) instead.

Specified by:

resolveDefaultOutputType in interface ReportExecutionPresentation

Returns:

the output type to run the report with, or null if this presentation cannot handle the template

requiresUserChoice

public boolean requiresUserChoice(@Nullable Report report,
 @Nullable ReportTemplate selectedTemplate,
 @Nullable ReportOutputType selectedOutputType)

Description copied from interface: ReportExecutionPresentation

A selection passed in the arguments does not automatically remove the need to ask: the built-in presentations still let the user choose between several compatible templates, but do not ask for an output type that has already been chosen.

Specified by:

requiresUserChoice in interface ReportExecutionPresentation

Returns:

true if the user must choose a template or an output type before the report can be run with this presentation