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 aTemplateVariationDefinition.- Author:
- Micha Kiener
-
-
Field Summary
Fields Modifier and Type Field Description protected StringkeyThe 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 booleanmandatoryReturnstrueif this parameter is mandatory and would prevent the template from being rendered if missing.protected StringnameThe optional name for this parameter (might be used as a label).protected StringtypeReturns the type of the parameter (e.g.
-
Constructor Summary
Constructors Constructor Description TemplateParameter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetKey()StringgetName()StringgetType()booleanisMandatory()voidsetKey(String key)voidsetMandatory(boolean mandatory)voidsetName(String name)voidsetType(String type)
-
-
-
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
Returnstrueif this parameter is mandatory and would prevent the template from being rendered if missing.
-
-
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)
-
-