Package com.broadleafcommerce.tax.domain

Class TaxResponseGroup

  • All Implemented Interfaces:
    Serializable
    public class TaxResponseGroup
extends Object
implements Serializable
    This represents of group of items whos taxes have been calculated together, typically with the same shipping address(es). This happens because sales tax jurisdictions are often dependent on where the items are being shipped to and/or from.
    Author:
    Kelly Tisdell (ktisdell)
    See Also:
    Serialized Form

    • 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

      • TaxResponseGroup

        public TaxResponseGroup()

    • 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.

      • canEqual

        protected boolean canEqual​(Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object