TransactionAmount (stumps 1.0-SNAPSHOT API)

java.lang.Object
- com.neurosys.domain.ModelObject
- - com.neurosys.domain.DomainObject
  - - com.neurosys.ecom.orders.domain.TransactionAmount

All Implemented Interfaces:

Auditable, IAmount<TransactionAmount>, Serializable, Cloneable, Comparable<IAmount>
```
@Embeddable
public class TransactionAmount
extends DomainObject
implements IAmount<TransactionAmount>
```
Basic amount with currency.

Author:

Arjun Dhar

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`TransactionAmount()`
`TransactionAmount(Double amount)` Initialized version will initialize all numerals to 0D
`TransactionAmount(Double total, String currency)`
`TransactionAmount(IAmount amt)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransactionAmount`	`add(TransactionAmount amt)` Will add the amount to the current amount and return the updated current amount; parameter null values are skipped
`TransactionAmount`	`clone()`
`int`	`compareTo(IAmount o)`
`TransactionAmount`	`deduct(TransactionAmount amt)` Will deduct the amount to the current amount and return the updated current amount; parameter null values are skipped
`boolean`	`equals(Object obj)`
`Double`	`getAmount()` The amount
`String`	`getConversionMetaData()` Details about currency conversion (if any). Implementation is Application dependent. Preferably the rate value or in JSON format.
`String`	`getCurrency()` The currency
`Double`	`getTotal()`
`int`	`hashCode()`
`void`	`setAmount(Double amount)` The amount
`void`	`setConversionMetaData(String conversionMetaData)` Details about currency conversion (if any). Implementation is Application dependent. Preferably the rate value or in JSON format.
`void`	`setCurrency(String currency)` The currency
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TransactionAmount
```
public TransactionAmount()
```
  - TransactionAmount
```
public TransactionAmount(Double amount)
```
    Initialized version will initialize all numerals to 0D
    
    Parameters:
    
    amount - as Double
  - TransactionAmount
```
public TransactionAmount(IAmount amt)
```
  - TransactionAmount
```
public TransactionAmount(Double total,
                         String currency)
```
    Parameters:
    
    total - as Double
    
    currency - as String
- Method Detail
  - getAmount
```
public Double getAmount()
```
    The amount
    
    Can be null:
    
    true : Transactions with errors can have a null amount
  - setAmount
```
public void setAmount(Double amount)
```
    The amount
    
    Can be null:
    
    true : Transactions with errors can have a null amount
  - getCurrency
```
public String getCurrency()
```
    The currency
    
    Specified by:
    
    getCurrency in interface IAmount<TransactionAmount>
    
    Can be null:
    
    true
  - setCurrency
```
public void setCurrency(String currency)
```
    The currency
    
    Can be null:
    
    true
  - getConversionMetaData
```
public String getConversionMetaData()
```
    Details about currency conversion (if any).
    Implementation is Application dependent.
    Preferably the rate value or in JSON format. E.g: {from:"INR", to:"USD", rate:0.0124 ..., round:true}
  - setConversionMetaData
```
public void setConversionMetaData(String conversionMetaData)
```
    Details about currency conversion (if any).
    Implementation is Application dependent.
    Preferably the rate value or in JSON format. E.g: {from:"INR", to:"USD", rate:0.0124 ..., round:true}
  - add
```
public TransactionAmount add(TransactionAmount amt)
```
    Will add the amount to the current amount and return the updated current amount; parameter null values are skipped
    
    Specified by:
    
    add in interface IAmount<TransactionAmount>
    
    Parameters:
    
    amt - as TransactionAmount
    
    Returns:
    
    this as TransactionAmount TODO: Add Unit test case; esp null scenarios
  - deduct
```
public TransactionAmount deduct(TransactionAmount amt)
```
    Will deduct the amount to the current amount and return the updated current amount; parameter null values are skipped
    
    Specified by:
    
    deduct in interface IAmount<TransactionAmount>
    
    Parameters:
    
    amt - as TransactionAmount
    
    Returns:
    
    this as TransactionAmount TODO: Add Unit test case; esp null scenarios
  - clone
```
public TransactionAmount clone()
```
    Overrides:
    
    clone in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(IAmount o)
```
    Specified by:
    
    compareTo in interface Comparable<IAmount>
  - getTotal
```
public Double getTotal()
```
    Specified by:
    
    getTotal in interface IAmount<TransactionAmount>

Class TransactionAmount

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TransactionAmount

TransactionAmount

TransactionAmount

TransactionAmount

Method Detail

getAmount

setAmount

getCurrency

setCurrency

getConversionMetaData

setConversionMetaData

add

deduct

clone

equals

hashCode

toString

compareTo

getTotal