com.elasticpath.xpf.connectivity.entity

Class XPFOrderItem

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

com.elasticpath.xpf.connectivity.entity.XPFOrderItem

public class XPFOrderItem
extends XPFEntity

Order Item entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XPFOrderItem.XPFOrderItemBuilder<C extends XPFOrderItem,B extends XPFOrderItem.XPFOrderItemBuilder<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
	XPFOrderItem(@NonNull String guid, @NonNull XPFProductSku productSku, int quantity, BigDecimal listUnitPrice, BigDecimal saleUnitPrice, BigDecimal promoUnitPrice, BigDecimal unitPrice, BigDecimal discountAmount, BigDecimal taxAmount, BigDecimal amount, String displayName, @NonNull Map<String,String> modifierFields, @NonNull List<XPFOrderItem> children, @NonNull XPFEntitySupplier<List<XPFTaxLine>> taxLines, boolean inventoryAllocated, @NonNull BigDecimal savings, @NonNull XPFEntitySupplier<XPFLinePricing> pricing)
protected	XPFOrderItem(XPFOrderItem.XPFOrderItemBuilder<?,?> b)

Method Summary

Modifier and Type	Method and Description
static XPFOrderItem.XPFOrderItemBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
BigDecimal	getAmount() Deprecated. use getPricing().withListPrice().withDiscounts().withApportionedContainerDiscounts().getAmount() instead
@NonNull List<XPFOrderItem>	getChildren() The children.
BigDecimal	getDiscountAmount() Deprecated. use getPricing().withDiscounts().getAmount() instead
String	getDisplayName() The display name.
@NonNull String	getGuid() The guid.
BigDecimal	getListUnitPrice() Deprecated. use getPricing().perUnit().withListPrice().getAmount() instead
@NonNull Map<String,String>	getModifierFields() The modifier fields.
XPFLinePricing	getPricing() The order item price calculator.
@NonNull XPFProductSku	getProductSku() The product sku.
BigDecimal	getPromoUnitPrice() Deprecated. use getPricing().perUnit().withListPrice().withDiscounts().getAmount() instead
int	getQuantity() The quantity.
BigDecimal	getSaleUnitPrice() Deprecated. no longer supported
@NonNull BigDecimal	getSavings() The savings.
BigDecimal	getTaxAmount() Deprecated. use getPricing().withTaxes().getAmount() instead
List<XPFTaxLine>	getTaxLines() Get the Tax Lines.
BigDecimal	getUnitPrice() Deprecated. use getPricing().perUnit().withListPrice().withDiscounts().getAmount() instead
int	hashCode()
boolean	isInventoryAllocated() Indicates if inventory has been allocated for the order item.
String	toString()

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

XPFOrderItem

protected XPFOrderItem(XPFOrderItem.XPFOrderItemBuilder<?,?> b)

XPFOrderItem

public XPFOrderItem(@NonNull
                    @NonNull String guid,
                    @NonNull
                    @NonNull XPFProductSku productSku,
                    int quantity,
                    BigDecimal listUnitPrice,
                    BigDecimal saleUnitPrice,
                    BigDecimal promoUnitPrice,
                    BigDecimal unitPrice,
                    BigDecimal discountAmount,
                    BigDecimal taxAmount,
                    BigDecimal amount,
                    String displayName,
                    @NonNull
                    @NonNull Map<String,String> modifierFields,
                    @NonNull
                    @NonNull List<XPFOrderItem> children,
                    @NonNull
                    @NonNull XPFEntitySupplier<List<XPFTaxLine>> taxLines,
                    boolean inventoryAllocated,
                    @NonNull
                    @NonNull BigDecimal savings,
                    @NonNull
                    @NonNull XPFEntitySupplier<XPFLinePricing> pricing)

Method Detail

getTaxLines

@LazyLoaded
public List<XPFTaxLine> getTaxLines()

Get the Tax Lines.

Returns:

the tax lines

getPricing

@LazyLoaded
public XPFLinePricing getPricing()

The order item price calculator.

Returns:

the price calculator

builder

public static XPFOrderItem.XPFOrderItemBuilder<?,?> builder()

getGuid

@NonNull
public @NonNull String getGuid()

The guid.

getProductSku

@NonNull
public @NonNull XPFProductSku getProductSku()

The product sku.

getQuantity

public int getQuantity()

The quantity.

getListUnitPrice

@Deprecated
public BigDecimal getListUnitPrice()

Deprecated. use getPricing().perUnit().withListPrice().getAmount() instead

The list unit price.

getSaleUnitPrice

@Deprecated
public BigDecimal getSaleUnitPrice()

Deprecated. no longer supported

The sale unit price.

getPromoUnitPrice

@Deprecated
public BigDecimal getPromoUnitPrice()

Deprecated. use getPricing().perUnit().withListPrice().withDiscounts().getAmount() instead

The promo unit price.

getUnitPrice

@Deprecated
public BigDecimal getUnitPrice()

Deprecated. use getPricing().perUnit().withListPrice().withDiscounts().getAmount() instead

The unit price.

getDiscountAmount

@Deprecated
public BigDecimal getDiscountAmount()

Deprecated. use getPricing().withDiscounts().getAmount() instead

The discount amount.

getTaxAmount

@Deprecated
public BigDecimal getTaxAmount()

Deprecated. use getPricing().withTaxes().getAmount() instead

The tax amount.

getAmount

@Deprecated
public BigDecimal getAmount()

Deprecated. use getPricing().withListPrice().withDiscounts().withApportionedContainerDiscounts().getAmount() instead

The amount.

getDisplayName

public String getDisplayName()

The display name.

getModifierFields

@NonNull
public @NonNull Map<String,String> getModifierFields()

The modifier fields.

getChildren

@NonNull
public @NonNull List<XPFOrderItem> getChildren()

The children.

isInventoryAllocated

public boolean isInventoryAllocated()

Indicates if inventory has been allocated for the order item.

getSavings

@NonNull
public @NonNull BigDecimal getSavings()

The savings.

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