com.apama.ccyconverter
Event Consts


The Consts event object contains a set of constants that define the various constant values for common settings, values, and configuration items in the Currency Converter.

These constants should be used rather than the specific value in order to ensure future compatibility.
Constant Summary
 constant stringCONFIG_BASE_CURRENCY := "BASE_CURRENCY"

This constant value defines the name of the configuration item used to configure what base currency the Currency Converter will use when constructing symbols.
 constant stringCONFIG_CROSS_CURRENCY_INFO := "CROSS_CURRENCY_INFO"

This constant value defines the name of the configuration item used to configure the cross currency pairs the Currency Converter will use when constructing symbols.
 constant stringCONFIG_CURRENCIES := "CURRENCIES"

This constant value defines the name of the configuration item used to configure the sequence of currencies the Currency Converter will use when constructing symbols.
 constant stringCONFIG_CURRENCY_SEPARATOR := "CURRENCY_SEPARATOR"

This constant value defines the name of the configuration item used to configure what currency separator the Currency Converter will use when constructing or splitting symbols.
 constant stringCONFIG_DEFAULT_CURRENCY_SEPARATOR := "/"

This constant value defines the default value for the CONFIG_CURRENCY_SEPARATOR parameter.
 constant booleanCONFIG_DEFAULT_ENABLE_PERSISTENCE := false

The Enable Persistence default configuration value is false.
 constant floatCONFIG_DEFAULT_TIMEOUT_DURATION := 5.0

This constant value defines the default value for the timeout duration configuration used for event communication.
 constant floatCONFIG_DEFAULT_UPDATE_TIMEOUT := 0.5

This constant value defines the default value for the update timeout.
 constant stringCONFIG_ENABLE_PERSISTENCE := "EnablePersistence"

The Enable Persistence configuration key that indicates whether or not persistence is enabled for the Currency Converter. The default value is false.
 constant stringCONFIG_SYMBOLS := "SYMBOLS"

This constant value defines the name of the configuration item used to configure what full symbols the Currency Converter will process in the format "CCY1/CCY2".
 constant stringCONFIG_TIMEOUT_DURATION := "TIMEOUT_DURATION"

This constant value defines the name of the configuration item used to configure the timeout duration for event communication.
 constant stringCONFIG_UPDATE_TIMEOUT := "UPDATE_TIMEOUT"

This constant value defines the name of the configuration item used to define the timeout to update the currency values. Zero if disabled.
 constant stringCONFIGSTORE_PATH_DEFAULT := "CurrencyConverter.sqlite"

The default file and path configuration value for the Currency Converter Configuration Store tables.
 constant stringCONFIGSTORE_PATH_KEY := "ConfigStorePath"

The configuration key value for setting the Currency Converter default file and path for its Configuration Store tables. This can be used to override the default storage location that the Currency Converter uses.
 constant stringCURRENCY_CONVERTER_SERVICE_TYPE := "CurrencyConverter"

The name of the Currency Converter Service that is registered with the CMF Service Framework.
 constant stringDEFAULT_FIELD_NAME := "VALUE"

This constant value defines the default field name used by the Currency Converter and Calculation Extension.
 
Constant Detail

CONFIG_BASE_CURRENCY

constant string CONFIG_BASE_CURRENCY := "BASE_CURRENCY"
This constant value defines the name of the configuration item used to configure what base currency the Currency Converter will use when constructing symbols.

Used in conjunction with the CONFIG_CURRENCIES param.
See Also:
com.apama.ccyconverter.Consts#CONFIG_CURRENCIES - 

CONFIG_CROSS_CURRENCY_INFO

constant string CONFIG_CROSS_CURRENCY_INFO := "CROSS_CURRENCY_INFO"
This constant value defines the name of the configuration item used to configure the cross currency pairs the Currency Converter will use when constructing symbols.

Used in conjunction with the CONFIG_SYMBOLS and CONFIG_CURRENCIES param.

The value of this configuration parameter must be a dictionary<string,string>.
See Also:
com.apama.ccyconverter.Consts#CONFIG_SYMBOLS - 
com.apama.ccyconverter.Consts#CONFIG_CURRENCIES - 

CONFIG_CURRENCIES

constant string CONFIG_CURRENCIES := "CURRENCIES"
This constant value defines the name of the configuration item used to configure the sequence of currencies the Currency Converter will use when constructing symbols.

Used in conjunction with the CONFIG_BASE_CURRENCY param.

The value of this configuration parameter must be a sequence<string>.
See Also:
com.apama.ccyconverter.Consts#CONFIG_BASE_CURRENCY - 

CONFIG_CURRENCY_SEPARATOR

constant string CONFIG_CURRENCY_SEPARATOR := "CURRENCY_SEPARATOR"
This constant value defines the name of the configuration item used to configure what currency separator the Currency Converter will use when constructing or splitting symbols.

The default value is "/".

CONFIG_DEFAULT_CURRENCY_SEPARATOR

constant string CONFIG_DEFAULT_CURRENCY_SEPARATOR := "/"
This constant value defines the default value for the CONFIG_CURRENCY_SEPARATOR parameter.

CONFIG_DEFAULT_ENABLE_PERSISTENCE

constant boolean CONFIG_DEFAULT_ENABLE_PERSISTENCE := false
The Enable Persistence default configuration value is false.

CONFIG_DEFAULT_TIMEOUT_DURATION

constant float CONFIG_DEFAULT_TIMEOUT_DURATION := 5.0
This constant value defines the default value for the timeout duration configuration used for event communication.

CONFIG_DEFAULT_UPDATE_TIMEOUT

constant float CONFIG_DEFAULT_UPDATE_TIMEOUT := 0.5
This constant value defines the default value for the update timeout.

CONFIG_ENABLE_PERSISTENCE

constant string CONFIG_ENABLE_PERSISTENCE := "EnablePersistence"
The Enable Persistence configuration key that indicates whether or not persistence is enabled for the Currency Converter. The default value is false.

CONFIG_SYMBOLS

constant string CONFIG_SYMBOLS := "SYMBOLS"
This constant value defines the name of the configuration item used to configure what full symbols the Currency Converter will process in the format "CCY1/CCY2".

The symbols will be split and any possible cross currency symbols automatically added.

The value of this configuration parameter must be a sequence<string>.

CONFIG_TIMEOUT_DURATION

constant string CONFIG_TIMEOUT_DURATION := "TIMEOUT_DURATION"
This constant value defines the name of the configuration item used to configure the timeout duration for event communication.

CONFIG_UPDATE_TIMEOUT

constant string CONFIG_UPDATE_TIMEOUT := "UPDATE_TIMEOUT"
This constant value defines the name of the configuration item used to define the timeout to update the currency values. Zero if disabled.

CONFIGSTORE_PATH_DEFAULT

constant string CONFIGSTORE_PATH_DEFAULT := "CurrencyConverter.sqlite"
The default file and path configuration value for the Currency Converter Configuration Store tables.

CONFIGSTORE_PATH_KEY

constant string CONFIGSTORE_PATH_KEY := "ConfigStorePath"
The configuration key value for setting the Currency Converter default file and path for its Configuration Store tables. This can be used to override the default storage location that the Currency Converter uses.

CURRENCY_CONVERTER_SERVICE_TYPE

constant string CURRENCY_CONVERTER_SERVICE_TYPE := "CurrencyConverter"
The name of the Currency Converter Service that is registered with the CMF Service Framework.

DEFAULT_FIELD_NAME

constant string DEFAULT_FIELD_NAME := "VALUE"
This constant value defines the default field name used by the Currency Converter and Calculation Extension.