com.flowable.template.api.repository

Class TemplateParameter

java.lang.Object

com.flowable.template.api.repository.TemplateParameter

public class TemplateParameter
extends Object

A single parameter definition used to describe the necessary payload when rendering a TemplateVariationDefinition.

Author:

Micha Kiener

Field Summary

Fields

Modifier and Type	Field and Description
protected String	key The key of this parameter which is used to later lookup the parameter value within the payload and might also be used within the template as a placeholder.
protected boolean	mandatory Returns true if this parameter is mandatory and would prevent the template from being rendered if missing.
protected String	name The optional name for this parameter (might be used as a label).
protected String	type Returns the type of the parameter (e.g.

Constructor Summary

Constructors

Constructor and Description
TemplateParameter()

Method Summary

Modifier and Type	Method and Description
String	getKey()
String	getName()
String	getType()
boolean	isMandatory()
void	setKey(String key)
void	setMandatory(boolean mandatory)
void	setName(String name)
void	setType(String type)

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

The optional name for this parameter (might be used as a label).

key

protected String key

The key of this parameter which is used to later lookup the parameter value within the payload and might also be used within the template as a placeholder.

type

protected String type

Returns the type of the parameter (e.g. string, long, date, etc).

mandatory

protected boolean mandatory

Returns true if this parameter is mandatory and would prevent the template from being rendered if missing.

Constructor Detail

TemplateParameter

public TemplateParameter()

Method Detail

getName

public String getName()

setName

public void setName(String name)

getKey

public String getKey()

setKey

public void setKey(String key)

getType

public String getType()

setType

public void setType(String type)

isMandatory

public boolean isMandatory()

setMandatory

public void setMandatory(boolean mandatory)