Package com.flowable.template.api.repository

Class VariationDefinition

java.lang.Object
com.flowable.template.api.repository.VariationDefinition
public class VariationDefinition
extends java.lang.Object
A variation describes a single variation used for a TemplateDefinition having multiple variations (e.g. different languages).
Author:
Micha Kiener

  • Field Summary

    Fields 
    Modifier and Type Field Description
    protected java.lang.String defaultValue
    Returns the default value for the key (used when no value is set or the specified variation does not exist)
    protected java.lang.String description
    The optional description for this variation, describing its meaning if needed.
    protected java.lang.String key
    Returns the variation key which is later used when mapped to variation data coming from another source (e.g.
    protected java.lang.String name
    The name of the variation (e.g.
    static java.lang.String NONE_VALUE
    The value to be used for a missing variation value (e.g.
    static java.lang.String VARIATION_DELIMINATOR
    The deliminator used when composing a combined variation key.

  • Constructor Summary

    Constructors 
    Constructor Description
    VariationDefinition()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDefaultValue()  
    java.lang.String getDescription()  
    java.lang.String getKey()  
    java.lang.String getName()  
    void setDefaultValue​(java.lang.String defaultValue)  
    void setDescription​(java.lang.String description)  
    void setKey​(java.lang.String key)  
    void setName​(java.lang.String name)  

    Methods inherited from class java.lang.Object

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

  • Field Details

    • NONE_VALUE

      public static final java.lang.String NONE_VALUE
      The value to be used for a missing variation value (e.g. 'none' instead of an empty language value or country value, etc).
      See Also:
      Constant Field Values

    • VARIATION_DELIMINATOR

      public static final java.lang.String VARIATION_DELIMINATOR
      The deliminator used when composing a combined variation key.
      See Also:
      Constant Field Values

    • name

      protected java.lang.String name
      The name of the variation (e.g. 'Language').

    • key

      protected java.lang.String key
      Returns the variation key which is later used when mapped to variation data coming from another source (e.g. from a process or case instance, etc).

    • defaultValue

      protected java.lang.String defaultValue
      Returns the default value for the key (used when no value is set or the specified variation does not exist)

    • description

      protected java.lang.String description
      The optional description for this variation, describing its meaning if needed.

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

    • getDefaultValue

      public java.lang.String getDefaultValue()

    • setDefaultValue

      public void setDefaultValue​(java.lang.String defaultValue)

    • getDescription

      public java.lang.String getDescription()

    • setDescription

      public void setDescription​(java.lang.String description)