com.apama.ccyconverter
Event CalculationExtension


The Calculation Extension defines the interface used by the Currency Converter to communicate and control a calculation object that supplies values.

A default implementation of an Extension can be implemented by using the CalculationExtensionFactory object. This implementation can then be overridden as required by the applications own custom code.

This event object should not be routed or enqueued.
See Also:
com.apama.ccyconverter.CalculationExtensionFactory - The Calculation Extension Factory object that creates a CalculationExtension.
com.apama.ccyconverter.CurrencyConverter - The Currency Converter.

Member Summary
 action< > returns sequence<string >getSchema

This is called by the Currency Converter during startup to obtain a sequence of field names it is to store in its cache.
 action<com.apama.ccyconverter.CurrencyConverter >onRegistered

This action is called by the Currency Converter when startup is completed. A Currency Converter interface is supplied which the Extension can use to set values.
 action<com.apama.ccyconverter.CurrencyConverter >refresh

This action is called by the Currency Converter when the update timeout has fired and the Extension should refresh all values. If the update timeout has been disabled, this will not be called.
 action<string >addSymbol

This action is called by the Currency Converter to notify the Extension of a new symbol it should attempt to supplying values for.
 action<string >removeSymbol

This action is called by the Currency Converter to notify it of a symbol it should stop supplying values for.
 
Member Detail

addSymbol

action<string > addSymbol
This action is called by the Currency Converter to notify the Extension of a new symbol it should attempt to supplying values for.

It is expected that the symbol can be invalid as the Currency Converter constructs all possible symbols from its parameters. In this case it should just be ignored.

Parameters:
symbol - The symbol to start supplying values for.
See Also:
com.apama.ccyconverter.CalculationExtension#removeSymbol - This action is called to stop the Extension from supplying values.

getSchema

action< > returns sequence<string > getSchema
This is called by the Currency Converter during startup to obtain a sequence of field names it is to store in its cache.

By default this will return a single field "VALUE" and the default get/setValue actions can be used on the Currency Converter interface. If the Extension is to supply other fields, this action must be overridden and the field names returned. They will then be accessible with the get/setCustomValue actions on the Currency Converter interface.

Returns:
A sequence of field names.

onRegistered

action<com.apama.ccyconverter.CurrencyConverter > onRegistered
This action is called by the Currency Converter when startup is completed. A Currency Converter interface is supplied which the Extension can use to set values.

Parameters:
currencyConverter - The Currency Converter interface the Extension can use to set values.

refresh

action<com.apama.ccyconverter.CurrencyConverter > refresh
This action is called by the Currency Converter when the update timeout has fired and the Extension should refresh all values. If the update timeout has been disabled, this will not be called.

Parameters:
currencyConverter - The Currency Converter interface the Extension can use to set values.

removeSymbol

action<string > removeSymbol
This action is called by the Currency Converter to notify it of a symbol it should stop supplying values for.

Parameters:
symbol - The symbol to stop supplying values for.
See Also:
com.apama.ccyconverter.CalculationExtension#addSymbol - This action is called to start the Extension supplying values.