Package io.jmix.reports.entity

Enum Class CustomTemplateDefinedBy

java.lang.Object

java.lang.Enum<CustomTemplateDefinedBy>

io.jmix.reports.entity.CustomTemplateDefinedBy

All Implemented Interfaces:

EnumClass<Integer>, Serializable, Comparable<CustomTemplateDefinedBy>, Constable

public enum CustomTemplateDefinedBy
extends Enum<CustomTemplateDefinedBy>
implements EnumClass<Integer>

Determines how a custom report generation is defined and invoked. Used by custom report templates.

See Also:

• CustomTemplateParameters
• ReportTemplate

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLASS	Custom template renderer is defined by a class located on the classpath.
DELEGATE	Object implementing CustomReport provided by the user.
SCRIPT	Custom template renderer is implemented as a Groovy script.
URL	Renderer is implemented as a remote HTTP service.

Method Summary

Modifier and Type	Method	Description
static CustomTemplateDefinedBy	fromId(Integer id)
Integer	getId()
static Integer	getId(CustomTemplateDefinedBy definedBy)
static CustomTemplateDefinedBy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CustomTemplateDefinedBy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CLASS

public static final CustomTemplateDefinedBy CLASS

Custom template renderer is defined by a class located on the classpath. The class must implement CustomReport, and must have a zero-argument constructor. The class is lazily loaded, and its instance is created at the moment of report generation.

SCRIPT

public static final CustomTemplateDefinedBy SCRIPT

Custom template renderer is implemented as a Groovy script.

URL

public static final CustomTemplateDefinedBy URL

Renderer is implemented as a remote HTTP service. Calling the renderer is performed in two stages:

1. Groovy script is called to determine the URL, including query parameters
2. command-line curl utility is used to invoke the remote service

CURL-related properties are applicable here.

See Also:

• ReportsProperties.getCurlPath()
• ReportsProperties.getCurlParams()
• ReportsProperties.getCurlTimeout()

DELEGATE

public static final CustomTemplateDefinedBy DELEGATE

Object implementing CustomReport provided by the user.

Method Details

values

public static CustomTemplateDefinedBy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CustomTemplateDefinedBy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getId

public Integer getId()

Specified by:

getId in interface EnumClass<Integer>

getId

public static Integer getId(CustomTemplateDefinedBy definedBy)

fromId

public static CustomTemplateDefinedBy fromId(Integer id)