java.lang.Object
- com.broadleafcommerce.tax.domain.TaxResponse

All Implemented Interfaces:

Serializable
```
public class TaxResponse
extends Object
implements Serializable
```
Response DTO from a TaxProvider that contains tax information for items.

Author:

Chad Harchar (charchar)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected Map<String,Object>`	`attributes`	Additional attributes for this tax response.
`protected String`	`fulfillmentGroupReferenceNumber`	The fulfillment group reference number.
`protected Map<String,TaxInfo>`	`taxInfos`	The tax infos for each of the line items, keyed by fulfillmentGroupReferenceNumber + "-" + itemId.
`protected javax.money.MonetaryAmount`	`totalAmount`	The total amount of the items.
`protected javax.money.MonetaryAmount`	`totalExemption`	The total amount that is not taxable from the items.
`protected javax.money.MonetaryAmount`	`totalTaxable`	The total amount that is taxable from the items.
`protected javax.money.MonetaryAmount`	`totalTaxCalculated`	The total tax calculated from all items.

Constructor Summary

Constructors
Constructor Description

TaxResponse()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`canEqual(Object other)`
`boolean`	`equals(Object o)`
`Map<String,Object>`	`getAttributes()`	Additional attributes for this tax response.
`String`	`getFulfillmentGroupReferenceNumber()`	The fulfillment group reference number.
`Map<String,TaxInfo>`	`getTaxInfos()`	The tax infos for each of the line items, keyed by fulfillmentGroupReferenceNumber + "-" + itemId.
`javax.money.MonetaryAmount`	`getTotalAmount()`	The total amount of the items.
`javax.money.MonetaryAmount`	`getTotalExemption()`	The total amount that is not taxable from the items.
`javax.money.MonetaryAmount`	`getTotalTaxable()`	The total amount that is taxable from the items.
`javax.money.MonetaryAmount`	`getTotalTaxCalculated()`	The total tax calculated from all items.
`int`	`hashCode()`
`void`	`setAttributes(Map<String,Object> attributes)`	Additional attributes for this tax response.
`void`	`setFulfillmentGroupReferenceNumber(String fulfillmentGroupReferenceNumber)`	The fulfillment group reference number.
`void`	`setTaxInfos(Map<String,TaxInfo> taxInfos)`	The tax infos for each of the line items, keyed by fulfillmentGroupReferenceNumber + "-" + itemId.
`void`	`setTotalAmount(javax.money.MonetaryAmount totalAmount)`	The total amount of the items.
`void`	`setTotalExemption(javax.money.MonetaryAmount totalExemption)`	The total amount that is not taxable from the items.
`void`	`setTotalTaxable(javax.money.MonetaryAmount totalTaxable)`	The total amount that is taxable from the items.
`void`	`setTotalTaxCalculated(javax.money.MonetaryAmount totalTaxCalculated)`	The total tax calculated from all items.
`String`	`toString()`

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

- Field Detail
  - totalAmount
```
protected javax.money.MonetaryAmount totalAmount
```
    The total amount of the items.
  - totalExemption
```
protected javax.money.MonetaryAmount totalExemption
```
    The total amount that is not taxable from the items.
  - totalTaxable
```
protected javax.money.MonetaryAmount totalTaxable
```
    The total amount that is taxable from the items.
  - totalTaxCalculated
```
protected javax.money.MonetaryAmount totalTaxCalculated
```
    The total tax calculated from all items.
  - fulfillmentGroupReferenceNumber
```
protected String fulfillmentGroupReferenceNumber
```
    The fulfillment group reference number.
  - taxInfos
```
protected Map<String,TaxInfo> taxInfos
```
    The tax infos for each of the line items, keyed by fulfillmentGroupReferenceNumber + "-" + itemId.
    For example, if a fulfillment group reference number is 999 and the item ID is 1234, the tax info for that item will be 999-1234
  - attributes
```
protected Map<String,Object> attributes
```
    Additional attributes for this tax response.
- Constructor Detail
  - TaxResponse
```
public TaxResponse()
```
- Method Detail
  - getTotalAmount
```
public javax.money.MonetaryAmount getTotalAmount()
```
    The total amount of the items.
    
    Returns:
    
    The total amount of the items.
  - getTotalExemption
```
public javax.money.MonetaryAmount getTotalExemption()
```
    The total amount that is not taxable from the items.
    
    Returns:
    
    The total amount that is not taxable from the items.
  - getTotalTaxable
```
public javax.money.MonetaryAmount getTotalTaxable()
```
    The total amount that is taxable from the items.
    
    Returns:
    
    The total amount that is taxable from the items.
  - getTotalTaxCalculated
```
public javax.money.MonetaryAmount getTotalTaxCalculated()
```
    The total tax calculated from all items.
    
    Returns:
    
    The total tax calculated from all items.
  - getFulfillmentGroupReferenceNumber
```
public String getFulfillmentGroupReferenceNumber()
```
    The fulfillment group reference number.
    
    Returns:
    
    The fulfillment group reference number
  - getTaxInfos
```
public Map<String,TaxInfo> getTaxInfos()
```
    The tax infos for each of the line items, keyed by fulfillmentGroupReferenceNumber + "-" + itemId.
    For example, if a fulfillment group reference number is 999 and the item ID is 1234, the tax info for that item will be 999-1234
    
    Returns:
    
    The tax infos for each of the line items.
  - getAttributes
```
public Map<String,Object> getAttributes()
```
    Additional attributes for this tax response.
    
    Returns:
    
    The attributes for this tax response.
  - setTotalAmount
```
public void setTotalAmount(javax.money.MonetaryAmount totalAmount)
```
    The total amount of the items.
    
    Parameters:
    
    totalAmount - The total amount of the items.
  - setTotalExemption
```
public void setTotalExemption(javax.money.MonetaryAmount totalExemption)
```
    The total amount that is not taxable from the items.
    
    Parameters:
    
    totalExemption - The total amount that is not taxable from the items.
  - setTotalTaxable
```
public void setTotalTaxable(javax.money.MonetaryAmount totalTaxable)
```
    The total amount that is taxable from the items.
    
    Parameters:
    
    totalTaxable - The total amount that is taxable from the items.
  - setTotalTaxCalculated
```
public void setTotalTaxCalculated(javax.money.MonetaryAmount totalTaxCalculated)
```
    The total tax calculated from all items.
    
    Parameters:
    
    totalTaxCalculated - The total tax calculated from all items.
  - setFulfillmentGroupReferenceNumber
```
public void setFulfillmentGroupReferenceNumber(String fulfillmentGroupReferenceNumber)
```
    The fulfillment group reference number.
    
    Parameters:
    
    fulfillmentGroupReferenceNumber - The fulfillment group reference number
  - setTaxInfos
```
public void setTaxInfos(Map<String,TaxInfo> taxInfos)
```
    The tax infos for each of the line items, keyed by fulfillmentGroupReferenceNumber + "-" + itemId.
    For example, if a fulfillment group reference number is 999 and the item ID is 1234, the tax info for that item will be 999-1234
    
    Parameters:
    
    taxInfos - The tax infos for each of the line items.
  - setAttributes
```
public void setAttributes(Map<String,Object> attributes)
```
    Additional attributes for this tax response.
    
    Parameters:
    
    taxInfos - The attributes for this tax response.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - canEqual
```
protected boolean canEqual(Object other)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TaxResponse

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

totalAmount

totalExemption

totalTaxable

totalTaxCalculated

fulfillmentGroupReferenceNumber

taxInfos

attributes

Constructor Detail

TaxResponse

Method Detail

getTotalAmount

getTotalExemption

getTotalTaxable

getTotalTaxCalculated

getFulfillmentGroupReferenceNumber

getTaxInfos

getAttributes

setTotalAmount

setTotalExemption

setTotalTaxable

setTotalTaxCalculated

setFulfillmentGroupReferenceNumber

setTaxInfos

setAttributes

equals

canEqual

hashCode

toString