Package com.flowable.template.api.repository

Class TemplateParameter

java.lang.Object
com.flowable.template.api.repository.TemplateParameter
public class TemplateParameter
extends java.lang.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 Description
    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.
    protected boolean mandatory
    Returns true if this parameter is mandatory and would prevent the template from being rendered if missing.
    protected java.lang.String name
    The optional name for this parameter (might be used as a label).
    protected java.lang.String type
    Returns the type of the parameter (e.g.

  • Constructor Summary

    Constructors 
    Constructor Description
    TemplateParameter()  

  • Method Summary

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

    Methods inherited from class java.lang.Object

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

  • Field Details

    • 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
      Returns true if this parameter is mandatory and would prevent the template from being rendered if missing.

  • Constructor Details

  • Method Details

    • 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)