Amount Class

Represents immutable amount with currency. Allows currency-safe amount calculcations.

Inheritance Hierarchy

SystemObject
Aloe.EnterpriseOne.ModelAmount

Namespace: Aloe.EnterpriseOne.Model
Assembly: Aloe.EnterpriseOne.Model (in Aloe.EnterpriseOne.Model.dll) Version: 20.1.3.5

Syntax

C++

Copy

public class Amount : IComparable, IComparable<Amount>, 
	IEquatable<Amount>, IValueWithMeasure<Currency>

Public Class Amount
	Implements IComparable, IComparable(Of Amount), 
	IEquatable(Of Amount), IValueWithMeasure(Of Currency)

public ref class Amount : IComparable, IComparable<Amount^>, 
	IEquatable<Amount^>, IValueWithMeasure<Currency^>

type Amount =  
    class
        interface IComparable
        interface IComparable<Amount>
        interface IEquatable<Amount>
        interface IValueWithMeasure<Currency>
    end

The Amount type exposes the following members.

Constructors

	Name	Description
	Amount	Initializes a new instance of the Amount class.

Top

Properties

	Name	Description
	Currency	Gets the currency of the amount.
	Value	Gets the value of the amount.
	Zero	Gets the zero amount, with no currency.

Top

Methods

	Name	Description
	Add	Returns the sum of the specified amounts. The amounts must have the same currency.
	AreCompatible	Returns true if the two amounts are compatible (e.g. have the same currency).
	Compare	Compares the amounts. The amounts must have the same currency.
	CompareTo(Object)	Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
	CompareTo(Amount)	Compares the current object with another object of the same type.
	Divide(Amount, Amount)	Divides the dividend by the divisor.
	Divide(Amount, Decimal)	Divides the specified amount.
	Equals(Object)	Determines whether the specified Object, is equal to this instance. (Overrides ObjectEquals(Object).)
	Equals(Amount)	Indicates whether the current object is equal to another object of the same type.
	GetHashCode	Returns a hash code for this instance. (Overrides ObjectGetHashCode.)
	Multiply	Multiplies the amount with the specified multiplier.
	Round	Returns new Amount, which is rounded, according to the rules of the currency.
	Subtract	Subtracts the second amount from the first. The amounts must have the same currency.
	ToString	Returns a String that represents this instance. (Overrides ObjectToString.)

Top

Operators

	Name	Description
	Addition	Returns the sum of the specified amounts. The amounts must have the same currency.
	Division(Amount, Amount)	Implements the operator /.
	Division(Amount, Decimal)	Implements the operator /.
	Equality	Implements the operator ==.
	GreaterThan	Compares first and second.
	GreaterThanOrEqual	Implements the operator >=.
	Inequality	Implements the operator !=.
	LessThan	Implements the operator <.
	LessThanOrEqual	Implements the operator <=.
	Multiply(Decimal, Amount)	Implements the operator *.
	Multiply(Amount, Decimal)	Implements the operator *.
	Subtraction	Subtracts the second amount from the first. The amounts must have the same currency.

Top

Remarks

Amount supports basic amount arithmetic, which is currency-safe. For example, adding two amounts is currency-safe, because the two amounts are added successfully only if their currencies are the same (or one of the amounts is zero). This helps avoid errors of inadvertently doing amount arithmetic with incompatible currencies.

The following basic rules are true for Amount:

Amount(15, USD) + Amount(10, USD) == Amount(25, USD)
Amount(15, USD) + Amount(10, EUR) => Exception!
Amount(15, USD) + Amount(10, null) => Exception!
Amount(15, USD) + Amount(0, null) == Amount(15, USD)
Amount(15, USD) + Amount(0, EUR) == Amount(15, USD)
Amount(15, USD) + null == Amount(15, USD)
Amount(15, USD) * 3 == Amount(45, USD)
Amount(15, USD) > Amount(10, USD) == true
Amount(15, USD) > Amount(0, EUR) == true
Amount(15, USD) > Amount(10, EUR) => Exception!
Amount(15, USD) > null == true

Reference

Aloe.EnterpriseOne.Model Namespace