Package io.jmix.reports.yarg.reporting

Class RunParams

java.lang.Object

io.jmix.reports.yarg.reporting.RunParams

public class RunParams
extends Object

Describes parameters necessary for report run

Field Summary

Fields

Modifier and Type	Field	Description
protected String	outputNamePattern
protected ReportOutputType	outputType
protected Map<String,Object>	params
protected Report	report
protected ReportTemplate	reportTemplate

Constructor Summary

Constructors

Constructor	Description
RunParams(Report report)

Method Summary

Modifier and Type	Method	Description
RunParams	output(ReportOutputType outputType)	Add output type
RunParams	outputNamePattern(String outputNamePattern)	Add output name pattern
RunParams	param(String key, Object value)	Add single parameter
RunParams	params(Map<String,Object> params)	Adds parameters from map
RunParams	template(ReportTemplate reportTemplate)	Setup template.
RunParams	templateCode(String templateCode)	Setup necessary template by string code.

Methods inherited from class java.lang.Object

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

Field Details

report

protected Report report

reportTemplate

protected ReportTemplate reportTemplate

outputType

protected ReportOutputType outputType

params

protected Map<String,Object> params

outputNamePattern

protected String outputNamePattern

Constructor Details

RunParams

public RunParams(Report report)

Method Details

templateCode

public RunParams templateCode(String templateCode)

Setup necessary template by string code. Throws validation exception if code is null or template not found

Parameters:

templateCode - - string code of template

template

public RunParams template(ReportTemplate reportTemplate)

Setup template. Throws validation exception if template is null

params

public RunParams params(Map<String,Object> params)

Adds parameters from map

param

public RunParams param(String key,
 Object value)

Add single parameter

output

public RunParams output(ReportOutputType outputType)

Add output type

outputNamePattern

public RunParams outputNamePattern(String outputNamePattern)

Add output name pattern