Smartswitch
Operations | List of all members
Smartswitch::Billing::Currency Interface Reference

This interface allows to access the Currency entity. More...

defined in <Currency.ice>

interface Currency { ... }

Operations

idempotent string getName ()
 Obtain a name of a Currency. More...
 
idempotent DoubleOpt getRate (string time)
 Obtain the current rate of a Currency relative to base currency at a given time. More...
 

Detailed Description

This interface allows to access the Currency entity.

Operation Documentation

◆ getName()

idempotent string getName ( )

Obtain a name of a Currency.

Returns
The name of a currency, for example 'USD'.

◆ getRate()

idempotent DoubleOpt getRate ( string  time)

Obtain the current rate of a Currency relative to base currency at a given time.

A base currency is configured by the Smartswitch administrator.
Smartswitch maintains the history of rate changes for each Currency.
Therefore, you can get a snapshot of a currency rate value at any given time.

Parameters
timeThe time we want to take a snapshot of rate.
Returns
The rate of a Currency at a given time.

The documentation for this interface was generated from the following file: