com.elasticpath.xpf.connectivity.entity

Class XPFOrderShipment

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

com.elasticpath.xpf.connectivity.entity.XPFOrderShipment

public class XPFOrderShipment
extends XPFEntity

Order shipment entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XPFOrderShipment.XPFOrderShipmentBuilder<C extends XPFOrderShipment,B extends XPFOrderShipment.XPFOrderShipmentBuilder<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
	XPFOrderShipment(@NonNull String shipmentNumber, @NonNull XPFShipmentTypeEnum shipmentType, @NonNull XPFShipmentStatusEnum status, XPFShippingInfo shippingInfo, @NonNull List<XPFOrderItem> lineItems, @NonNull BigDecimal itemSubtotal, @NonNull BigDecimal subtotalDiscount, @NonNull BigDecimal itemTax, @NonNull XPFTaxCalculationMethodEnum taxCalculationMethod, String taxDocumentId, List<XPFTotalTaxLine> totalTaxLines, boolean taxInclusive, BigDecimal shippingCost, @NonNull BigDecimal totalBeforeTax, BigDecimal shippingTax, @NonNull BigDecimal total, @NonNull XPFEntitySupplier<XPFContainerPricing> pricing)
protected	XPFOrderShipment(XPFOrderShipment.XPFOrderShipmentBuilder<?,?> b)

Method Summary

Modifier and Type	Method and Description
static XPFOrderShipment.XPFOrderShipmentBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@NonNull BigDecimal	getItemSubtotal() Deprecated. use getPricing().withSubtotal().getAmount() instead
@NonNull BigDecimal	getItemTax() Deprecated. use getPricing().withTaxes().getAmount() instead
@NonNull List<XPFOrderItem>	getLineItems() The order items.
@NonNull XPFContainerPricing	getPricing() The order shipment price calculator.
@NonNull String	getShipmentNumber() The shipment number.
@NonNull XPFShipmentTypeEnum	getShipmentType() The shipment type.
BigDecimal	getShippingCost() Deprecated. use getPricing().withShippingSubtotal().getAmount instead
XPFShippingInfo	getShippingInfo() The shipping info.
BigDecimal	getShippingTax() Deprecated. use getPricing().withShippingTaxes().getAmount() instead
@NonNull XPFShipmentStatusEnum	getStatus() The shipment status.
@NonNull BigDecimal	getSubtotalDiscount() Deprecated. use getPricing().withContainerDiscounts().getAmount() instead
@NonNull XPFTaxCalculationMethodEnum	getTaxCalculationMethod() The tax calculation method.
String	getTaxDocumentId() The tax document id.
@NonNull BigDecimal	getTotal() Deprecated. use getPricing().withTotal().getAmount() instead
@NonNull BigDecimal	getTotalBeforeTax() Deprecated. use getPricing().withSubtotal().withContainerDiscounts().withShippingSubtotal().withShippingDiscounts().getAmount()
List<XPFTotalTaxLine>	getTotalTaxLines() The total tax lines.
int	hashCode()
boolean	isTaxInclusive() Indicates if the shipment uses inclusive tax.
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

XPFOrderShipment

protected XPFOrderShipment(XPFOrderShipment.XPFOrderShipmentBuilder<?,?> b)

XPFOrderShipment

public XPFOrderShipment(@NonNull
                        @NonNull String shipmentNumber,
                        @NonNull
                        @NonNull XPFShipmentTypeEnum shipmentType,
                        @NonNull
                        @NonNull XPFShipmentStatusEnum status,
                        XPFShippingInfo shippingInfo,
                        @NonNull
                        @NonNull List<XPFOrderItem> lineItems,
                        @NonNull
                        @NonNull BigDecimal itemSubtotal,
                        @NonNull
                        @NonNull BigDecimal subtotalDiscount,
                        @NonNull
                        @NonNull BigDecimal itemTax,
                        @NonNull
                        @NonNull XPFTaxCalculationMethodEnum taxCalculationMethod,
                        String taxDocumentId,
                        List<XPFTotalTaxLine> totalTaxLines,
                        boolean taxInclusive,
                        BigDecimal shippingCost,
                        @NonNull
                        @NonNull BigDecimal totalBeforeTax,
                        BigDecimal shippingTax,
                        @NonNull
                        @NonNull BigDecimal total,
                        @NonNull
                        @NonNull XPFEntitySupplier<XPFContainerPricing> pricing)

Method Detail

getPricing

@LazyLoaded
 @NonNull
public @NonNull XPFContainerPricing getPricing()

The order shipment price calculator.

Returns:

the price calculator

builder

public static XPFOrderShipment.XPFOrderShipmentBuilder<?,?> builder()

getShipmentNumber

@NonNull
public @NonNull String getShipmentNumber()

The shipment number.

getShipmentType

@NonNull
public @NonNull XPFShipmentTypeEnum getShipmentType()

The shipment type.

getStatus

@NonNull
public @NonNull XPFShipmentStatusEnum getStatus()

The shipment status.

getShippingInfo

public XPFShippingInfo getShippingInfo()

The shipping info.

getLineItems

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

The order items.

getItemSubtotal

@Deprecated
 @NonNull
public @NonNull BigDecimal getItemSubtotal()

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

The item subtotal.

getSubtotalDiscount

@Deprecated
 @NonNull
public @NonNull BigDecimal getSubtotalDiscount()

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

The subtotal discount.

getItemTax

@Deprecated
 @NonNull
public @NonNull BigDecimal getItemTax()

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

The item tax.

getTaxCalculationMethod

@NonNull
public @NonNull XPFTaxCalculationMethodEnum getTaxCalculationMethod()

The tax calculation method.

getTaxDocumentId

public String getTaxDocumentId()

The tax document id.

getTotalTaxLines

public List<XPFTotalTaxLine> getTotalTaxLines()

The total tax lines.

isTaxInclusive

public boolean isTaxInclusive()

Indicates if the shipment uses inclusive tax.

getShippingCost

@Deprecated
public BigDecimal getShippingCost()

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

The shipping cost.

getTotalBeforeTax

@Deprecated
 @NonNull
public @NonNull BigDecimal getTotalBeforeTax()

Deprecated. use getPricing().withSubtotal().withContainerDiscounts().withShippingSubtotal().withShippingDiscounts().getAmount()

The total before tax.

getShippingTax

@Deprecated
public BigDecimal getShippingTax()

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

The shipping tax.

getTotal

@Deprecated
 @NonNull
public @NonNull BigDecimal getTotal()

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

The total.

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