Package com.aquima.interactions.ds

Class ValueFormatDefinition

java.lang.Object

com.aquima.interactions.ds.ValueFormatDefinition

All Implemented Interfaces:

IValueFormatDefinition, Serializable

public class ValueFormatDefinition
extends Object
implements IValueFormatDefinition

This class holds a single value format definition for the application configuration.

Since:

7.0

Author:

O. Kerpershoek

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ValueFormatDefinition(String type, String name, String pattern, String languageCode)	Constructs the value format definition with the required arguments.

Method Summary

Modifier and Type	Method	Description
String	getLanguageCode()	This method returns the language code of the language that should be used for language specific symbols.
String	getName()	This method returns the name of the value format definition.
String	getPattern()	This method returns the actual value format pattern that should be used by the value format.
DataType	getType()	This method returns the data type the value format was defined for.

Methods inherited from class java.lang.Object

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

Constructor Details

ValueFormatDefinition

public ValueFormatDefinition(String type,
 String name,
 String pattern,
 String languageCode)

Constructs the value format definition with the required arguments.

Parameters:

type - The data type the value format is defined for.

name - The name of the value format.

pattern - The value format pattern that should be used.

languageCode - The code of the language that should be used to resolve language specific symbols.

Method Details

getName

public String getName()

This method returns the name of the value format definition. If this name is equal to a value format defined in Studio, this value format definition will replace the definition from studio.

Specified by:

getName in interface IValueFormatDefinition

Returns:

The name of the value format definition.

getType

public DataType getType()

This method returns the data type the value format was defined for.

Specified by:

getType in interface IValueFormatDefinition

Returns:

The data type the value format was defined for.

getLanguageCode

public String getLanguageCode()

This method returns the language code of the language that should be used for language specific symbols. Not all value formats do need language specific symbols, so the language code might be null for certain patterns.

Specified by:

getLanguageCode in interface IValueFormatDefinition

Returns:

the language code of the language that should be used for language specific symbols.

getPattern

public String getPattern()

This method returns the actual value format pattern that should be used by the value format.

Specified by:

getPattern in interface IValueFormatDefinition

Returns:

the actual value format pattern that should be used by the value format.