Amount (stumps 1.0-SNAPSHOT API)

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

All Implemented Interfaces:

Auditable, IAmount<Amount>, Serializable, Cloneable, Comparable<IAmount>
```
@Embeddable
public class Amount
extends DomainObject
implements IAmount<Amount>
```
Amount breakup and details for an Item (inclusive of all Quantity).
"for all Quantity" is not the same as "SUM of all prices * Quantity" always, because one may apply complex discount rules based on Quantity etc. The final amount is after all calculations etc. The Amount does not maintain the calculation details; just the break up.

If setSubAmounts(List) is defined, then any operations on this like add(Amount), deduct(Amount) will show up in the sub-amounts

Author:

Arjun Dhar

See Also:

Serialized Form

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Amount`	`add(Amount amt)` Will add the amount to the current amount and return the updated current amount; parameter null values are skipped
`Amount`	`clone()`
`int`	`compareTo(IAmount o)`
`Amount`	`deduct(Amount 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`	`getBase()` In the default behavior/understanding, the base price reflect the regular total of the product
`String`	`getCurrency()`
`Double`	`getDiscount()` Should be a (-) quantity if discount is being offered.
`Integer`	`getPrecision()` When storing decimal numbers or fractions, recurring decimals could be rounded or truncated at some point.
`String`	`getRegion()`
`List<Amount>`	`getSubAmounts()` A `Transient` field, if NOT null, will also track any sub-calculations (AAmount) used in cumulative operations while calculating this Amount.
`Double`	`getTax()`
`Boolean`	`getTaxReverseCaculated()` In some cases the tax maybe already included in the product/item value.
`Double`	`getTotal()`
`int`	`hashCode()`
`void`	`setBase(Double base)` In the default behavior/understanding, the base price reflect the regular total of the product
`void`	`setCurrency(String currency)`
`void`	`setDiscount(Double discount)` Should be a (-) quantity if discount is being offered.
`void`	`setPrecision(Integer precision)` When storing decimal numbers or fractions, recurring decimals could be rounded or truncated at some point.
`void`	`setRegion(String region)`
`void`	`setSubAmounts(List<Amount> subAmounts)` A `Transient` field, if NOT null, will also track any sub-calculations (AAmount) used in cumulative operations while calculating this Amount.
`void`	`setTax(Double tax)`
`void`	`setTaxReverseCaculated(Boolean taxReverseCaculated)` In some cases the tax maybe already included in the product/item value.
`void`	`setTotal(Double total)`
`String`	`toString()`

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

- Constructor Detail
  - Amount
```
public Amount()
```
  - Amount
```
public Amount(Double total)
```
    Initialized version will initialize all numerals to 0D
    
    Parameters:
    
    total - as Double
  - Amount
```
public Amount(IAmount amt)
```
  - Amount
```
public Amount(Double total,
              String currency)
```
    Parameters:
    
    total - as Double
    
    currency - as String
- Method Detail
  - getBase
```
public Double getBase()
```
    In the default behavior/understanding, the base price reflect the regular total of the product
    
    Returns:
    
    Double
  - setBase
```
public void setBase(Double base)
```
    In the default behavior/understanding, the base price reflect the regular total of the product
    
    Parameters:
    
    base - as Double
  - getDiscount
```
public Double getDiscount()
```
    Should be a (-) quantity if discount is being offered. In calculations discount is deducted; hence deduct(Amount) is called. Hence this should be negative.
  - setDiscount
```
public void setDiscount(Double discount)
```
    Should be a (-) quantity if discount is being offered. In calculations discount is deducted; hence deduct(Amount) is called. Hence this should be negative.
  - getTax
```
public Double getTax()
```
  - setTax
```
public void setTax(Double tax)
```
  - getTotal
```
public Double getTotal()
```
    Specified by:
    
    getTotal in interface IAmount<Amount>
  - setTotal
```
public void setTotal(Double total)
```
  - getCurrency
```
public String getCurrency()
```
    Specified by:
    
    getCurrency in interface IAmount<Amount>
  - setCurrency
```
public void setCurrency(String currency)
```
  - getRegion
```
public String getRegion()
```
  - setRegion
```
public void setRegion(String region)
```
  - getPrecision
```
public Integer getPrecision()
```
    When storing decimal numbers or fractions, recurring decimals could be rounded or truncated at some point. For the sake of accuracy, if any number was truncated (precision=0) or precise upto a given number, then that should be specified here.
    
    Can be null:
    
    true (Dont care = false, that the number as is)
  - setPrecision
```
public void setPrecision(Integer precision)
```
    When storing decimal numbers or fractions, recurring decimals could be rounded or truncated at some point. For the sake of accuracy, if any number was truncated (precision=0) or precise upto a given number, then that should be specified here.
    
    Can be null:
    
    true (Dont care = false, that the number as is)
  - getTaxReverseCaculated
```
public Boolean getTaxReverseCaculated()
```
    In some cases the tax maybe already included in the product/item value. In those cases the base is re-calculated by subtracting the tax (%) from the Product amount.
    If this is done then taxReverseCaculated = true
  - setTaxReverseCaculated
```
public void setTaxReverseCaculated(Boolean taxReverseCaculated)
```
    In some cases the tax maybe already included in the product/item value. In those cases the base is re-calculated by subtracting the tax (%) from the Product amount.
    If this is done then taxReverseCaculated = true
  - add
```
public Amount add(Amount 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<Amount>
    
    Parameters:
    
    amt - as Amount
    
    Returns:
    
    this as Amount TODO: Add Unit test case; esp null scenarios
  - deduct
```
public Amount deduct(Amount 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<Amount>
    
    Parameters:
    
    amt - as Amount
    
    Returns:
    
    this as Amount TODO: Add Unit test case; esp null scenarios
  - getSubAmounts
```
public List<Amount> getSubAmounts()
```
    A Transient field, if NOT null, will also track any sub-calculations (AAmount) used in cumulative operations while calculating this Amount.
    
    Can be null:
    
    true
  - setSubAmounts
```
public void setSubAmounts(List<Amount> subAmounts)
```
    A Transient field, if NOT null, will also track any sub-calculations (AAmount) used in cumulative operations while calculating this Amount.
    
    Can be null:
    
    true
  - clone
```
public Amount 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>

Class Amount

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Amount

Amount

Amount

Amount

Method Detail

getBase

setBase

getDiscount

setDiscount

getTax

setTax

getTotal

setTotal

getCurrency

setCurrency

getRegion

setRegion

getPrecision

setPrecision

getTaxReverseCaculated

setTaxReverseCaculated

add

deduct

getSubAmounts

setSubAmounts

clone

equals

hashCode

toString

compareTo