com.elasticpath.xpf.connectivity.entity

Class XPFContainerPricing

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

com.elasticpath.xpf.connectivity.entity.XPFContainerPricing

public class XPFContainerPricing
extends XPFEntity

Represents pricing for a container, such as a shopping cart or an order, including subtotal, discounts, taxes, and shipping costs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XPFContainerPricing.XPFContainerPricingBuilder<C extends XPFContainerPricing,B extends XPFContainerPricing.XPFContainerPricingBuilder<C,B>>

Nested classes/interfaces inherited from class com.elasticpath.xpf.connectivity.entity.XPFEntity

XPFEntity.XPFEntityBuilder<C extends XPFEntity,B extends XPFEntity.XPFEntityBuilder<C,B>>

Constructor Summary

Constructors

Modifier	Constructor and Description
	XPFContainerPricing(BigDecimal subtotal, BigDecimal containerDiscounts, BigDecimal taxes, BigDecimal shippingSubtotal, BigDecimal shippingDiscounts, BigDecimal shippingTaxes, Currency currency)
protected	XPFContainerPricing(XPFContainerPricing.XPFContainerPricingBuilder<?,?> b)

Method Summary

Modifier and Type	Method and Description
static XPFContainerPricing.XPFContainerPricingBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
BigDecimal	getAmount() Calculates the final amount based on selected flags.
protected BigDecimal	getContainerDiscounts() Returns the container discounts of this pricing.
Currency	getCurrency() Returns the currency of this pricing.
protected BigDecimal	getShippingDiscounts() Returns the shipping discounts of this pricing.
protected BigDecimal	getShippingSubtotal() Returns the shipping subtotal of this pricing.
protected BigDecimal	getShippingTaxes() Returns the shipping taxes of this pricing.
protected BigDecimal	getSubtotal() Returns the subtotal of this pricing.
protected BigDecimal	getTaxes() Returns the taxes of this pricing.
int	hashCode()
boolean	isNonZero() Checks if the calculated amount is non-zero.
String	toString()
XPFContainerPricing	withContainerDiscounts() Includes the cart, order, or order shipment discounts, but does not include any line-level discounts.
XPFContainerPricing	withShippingDiscounts() Includes shipping discounts in the calculation.
XPFContainerPricing	withShippingSubtotal() Includes shipping subtotal but not shipping discounts or taxes in the calculation.
XPFContainerPricing	withShippingTaxes() Includes shipping taxes in the calculation.
XPFContainerPricing	withSubtotal() Includes line item subtotals and line-level discounts, but does not include any cart, order, or order shipment discounts, taxes, or shipping, for all line items.
XPFContainerPricing	withTaxes() Includes item taxes but not shipping taxes in the calculation.
XPFContainerPricing	withTotal() This is a convenience method that is equivalent to withSubtotal().withContainerDiscounts().withTaxes().withShippingSubtotal().withShippingDiscounts().withShippingTaxes().

Methods inherited from class com.elasticpath.xpf.connectivity.entity.XPFEntity

getCustomData, getCustomDataValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XPFContainerPricing

protected XPFContainerPricing(XPFContainerPricing.XPFContainerPricingBuilder<?,?> b)

XPFContainerPricing

public XPFContainerPricing(BigDecimal subtotal,
                           BigDecimal containerDiscounts,
                           BigDecimal taxes,
                           BigDecimal shippingSubtotal,
                           BigDecimal shippingDiscounts,
                           BigDecimal shippingTaxes,
                           Currency currency)

Method Detail

withSubtotal

public XPFContainerPricing withSubtotal()

Includes line item subtotals and line-level discounts, but does not include any cart, order, or order shipment discounts, taxes, or shipping, for all line items.

Returns:

this

withContainerDiscounts

public XPFContainerPricing withContainerDiscounts()

Includes the cart, order, or order shipment discounts, but does not include any line-level discounts.

Returns:

this

withTaxes

public XPFContainerPricing withTaxes()

Includes item taxes but not shipping taxes in the calculation.

Returns:

this

withShippingSubtotal

public XPFContainerPricing withShippingSubtotal()

Includes shipping subtotal but not shipping discounts or taxes in the calculation.

Returns:

this

withShippingDiscounts

public XPFContainerPricing withShippingDiscounts()

Includes shipping discounts in the calculation.

Returns:

this

withShippingTaxes

public XPFContainerPricing withShippingTaxes()

Includes shipping taxes in the calculation.

Returns:

this

withTotal

public XPFContainerPricing withTotal()

This is a convenience method that is equivalent to withSubtotal().withContainerDiscounts().withTaxes().withShippingSubtotal().withShippingDiscounts().withShippingTaxes().

Returns:

this

getAmount

public BigDecimal getAmount()

Calculates the final amount based on selected flags.

Returns:

the calculated amount

isNonZero

public boolean isNonZero()

Checks if the calculated amount is non-zero.

Returns:

true if the amount is non-zero

getCurrency

public Currency getCurrency()

Returns the currency of this pricing.

Returns:

the currency

getSubtotal

protected BigDecimal getSubtotal()

Returns the subtotal of this pricing.

Returns:

the subtotal

getContainerDiscounts

protected BigDecimal getContainerDiscounts()

Returns the container discounts of this pricing.

Returns:

the container discounts

getTaxes

protected BigDecimal getTaxes()

Returns the taxes of this pricing.

Returns:

the taxes

getShippingSubtotal

protected BigDecimal getShippingSubtotal()

Returns the shipping subtotal of this pricing.

Returns:

the shipping subtotal

getShippingDiscounts

protected BigDecimal getShippingDiscounts()

Returns the shipping discounts of this pricing.

Returns:

the shipping discounts

getShippingTaxes

protected BigDecimal getShippingTaxes()

Returns the shipping taxes of this pricing.

Returns:

the shipping taxes

builder

public static XPFContainerPricing.XPFContainerPricingBuilder<?,?> builder()

toString

public String toString()

Overrides:

toString in class XPFEntity

equals

public boolean equals(Object o)

Overrides:

equals in class XPFEntity

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class XPFEntity

hashCode

public int hashCode()

Overrides:

hashCode in class XPFEntity