Skip to main content
Kinetic Community

Currency Field Value

This class represents a currency field value.  It contains data about the currency value including the value, currency, and conversion date.

Instance Methods

value Returns the number value of the currency value.
value= Sets the number value of the currency value.
currency Returns the currency type of the currency value.
currency= Sets the currency type of the currency value.
conversion_date Returns the conversion date of the currency value.
conversion_date= Sets the conversion date of the currency value.
functional_currencies

Returns a hash representing the functional currencies.  The functional currencies hash maps the currency type abbreviation to the value for that currency type.  Below is an example of what the functional currencies hash looks like.

{
  :USD => 0.0,
  :CAD => 0.0
}
functional_currencies= Sets the functional currencies hash.
[]

Returns the number value of the currency value for the given currency type.  Note that this uses the functional currencies hash to determine the proper value.

In the example below we use the [] method to access the USD value from the currency value.

entry["Currency Field"][:USD]
to_s Returns a specially formatted string representing the CurrencyFieldValue instance including the value and currency type.
inspect Returns a specially formatted string representing the CurrencyFieldValue instance including the value, currency type, and conversion date.