Class TemplateParameter
- java.lang.Object
-
- com.flowable.template.api.repository.TemplateParameter
-
public class TemplateParameter extends java.lang.ObjectA single parameter definition used to describe the necessary payload when rendering aTemplateVariationDefinition.- Author:
- Micha Kiener
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.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 java.lang.StringnameThe optional name for this parameter (might be used as a label).protected java.lang.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 java.lang.StringgetKey()java.lang.StringgetName()java.lang.StringgetType()booleanisMandatory()voidsetKey(java.lang.String key)voidsetMandatory(boolean mandatory)voidsetName(java.lang.String name)voidsetType(java.lang.String type)
-
-
-
Field Detail
-
name
protected java.lang.String name
The optional name for this parameter (might be used as a label).
-
key
protected java.lang.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 java.lang.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 java.lang.String getName()
-
setName
public void setName(java.lang.String name)
-
getKey
public java.lang.String getKey()
-
setKey
public void setKey(java.lang.String key)
-
getType
public java.lang.String getType()
-
setType
public void setType(java.lang.String type)
-
isMandatory
public boolean isMandatory()
-
setMandatory
public void setMandatory(boolean mandatory)
-
-