Package com.flowable.template.api.repository

Class VariationDefinition

java.lang.Object

com.flowable.template.api.repository.VariationDefinition

public class VariationDefinition
extends 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 String	defaultValue	Returns the default value for the key (used when no value is set or the specified variation does not exist)
protected String	description	The optional description for this variation, describing its meaning if needed.
protected String	key	Returns the variation key which is later used when mapped to variation data coming from another source (e.g.
protected String	name	The name of the variation (e.g.
static final String	NONE_VALUE	The value to be used for a missing variation value (e.g.
static final 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
String	getDefaultValue()
String	getDescription()
String	getKey()
String	getName()
void	setDefaultValue(String defaultValue)
void	setDescription(String description)
void	setKey(String key)
void	setName(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 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 String VARIATION_DELIMINATOR

The deliminator used when composing a combined variation key.

See Also:

• Constant Field Values

name

protected String name

The name of the variation (e.g. 'Language').

key

protected 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 String defaultValue

Returns the default value for the key (used when no value is set or the specified variation does not exist)

description

protected String description

The optional description for this variation, describing its meaning if needed.

Constructor Details

VariationDefinition

public VariationDefinition()

Method Details

getName

public String getName()

setName

public void setName(String name)

getKey

public String getKey()

setKey

public void setKey(String key)

getDefaultValue

public String getDefaultValue()

setDefaultValue

public void setDefaultValue(String defaultValue)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)