com.elasticpath.xpf.connectivity.entity

Class XPFLinePricing

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

com.elasticpath.xpf.connectivity.entity.XPFLinePricing

public class XPFLinePricing
extends XPFEntity

Represents pricing for a line item, supporting various pricing components.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XPFLinePricing.XPFLinePricingBuilder<C extends XPFLinePricing,B extends XPFLinePricing.XPFLinePricingBuilder<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
	XPFLinePricing(BigDecimal perUnitListPrice, BigDecimal listPrice, BigDecimal perUnitDiscounts, BigDecimal discounts, XPFEntitySupplier<BigDecimal> perUnitApportionedContainerDiscounts, XPFEntitySupplier<BigDecimal> apportionedContainerDiscounts, @NonNull Currency currency)
protected	XPFLinePricing(XPFLinePricing.XPFLinePricingBuilder<?,?> b)

Method Summary

Modifier and Type	Method and Description
static XPFLinePricing.XPFLinePricingBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
BigDecimal	getAmount() Calculates the final amount based on selected flags.
protected BigDecimal	getApportionedContainerDiscounts() Returns the apportioned container discounts of this pricing.
Currency	getCurrency() Returns the currency of this pricing.
protected BigDecimal	getDiscounts() Returns the discounts of this pricing.
protected BigDecimal	getListPrice() Returns the list price of this pricing.
protected BigDecimal	getPerUnitApportionedContainerDiscounts() Returns the per unit apportioned container discounts of this pricing.
protected BigDecimal	getPerUnitDiscounts() Returns the per unit discounts of this pricing.
protected BigDecimal	getPerUnitListPrice() Returns the per unit list price of this pricing.
int	hashCode()
boolean	isNonZero() Checks if the calculated amount is non-zero.
XPFLinePricing	perUnit() Indicates that pricing should be per unit, rather than for all quantities on the line item.
String	toString()
XPFLinePricing	withApportionedContainerDiscounts() Includes the line item apportioned value of the container discounts in the calculation.
XPFLinePricing	withDiscounts() Includes the difference between the list price and sale price, plus catalog and cart line-level promotion discounts in the calculation.
XPFLinePricing	withListPrice() Includes the item list price in the calculation.

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

XPFLinePricing

protected XPFLinePricing(XPFLinePricing.XPFLinePricingBuilder<?,?> b)

XPFLinePricing

public XPFLinePricing(BigDecimal perUnitListPrice,
                      BigDecimal listPrice,
                      BigDecimal perUnitDiscounts,
                      BigDecimal discounts,
                      XPFEntitySupplier<BigDecimal> perUnitApportionedContainerDiscounts,
                      XPFEntitySupplier<BigDecimal> apportionedContainerDiscounts,
                      @NonNull
                      @NonNull Currency currency)

Method Detail

perUnit

public XPFLinePricing perUnit()

Indicates that pricing should be per unit, rather than for all quantities on the line item.

Returns:

this

withListPrice

public XPFLinePricing withListPrice()

Includes the item list price in the calculation.

Returns:

this

withDiscounts

public XPFLinePricing withDiscounts()

Includes the difference between the list price and sale price, plus catalog and cart line-level promotion discounts in the calculation.

Returns:

this

withApportionedContainerDiscounts

public XPFLinePricing withApportionedContainerDiscounts()

Includes the line item apportioned value of the container discounts in the calculation.

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

getPerUnitListPrice

protected BigDecimal getPerUnitListPrice()

Returns the per unit list price of this pricing.

Returns:

the per unit list price

getListPrice

protected BigDecimal getListPrice()

Returns the list price of this pricing.

Returns:

the list price

getPerUnitDiscounts

protected BigDecimal getPerUnitDiscounts()

Returns the per unit discounts of this pricing.

Returns:

the per unit discounts

getDiscounts

protected BigDecimal getDiscounts()

Returns the discounts of this pricing.

Returns:

the discounts

getPerUnitApportionedContainerDiscounts

protected BigDecimal getPerUnitApportionedContainerDiscounts()

Returns the per unit apportioned container discounts of this pricing.

Returns:

the per unit apportioned container discounts

getApportionedContainerDiscounts

protected BigDecimal getApportionedContainerDiscounts()

Returns the apportioned container discounts of this pricing.

Returns:

the apportioned container discounts

builder

public static XPFLinePricing.XPFLinePricingBuilder<?,?> 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