com.elasticpath.xpf.connectivity.entity

Class XPFOrder

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

com.elasticpath.xpf.connectivity.entity.XPFOrder

public class XPFOrder
extends XPFEntity

Order entity.

Constructor Summary

Constructors

Constructor and Description

XPFOrder(@NonNull String orderNumber, @NonNull Date createdDate, Locale locale, @NonNull Currency currency, @NonNull XPFOrderStatusEnum status, @NonNull XPFStore store, XPFCustomer account, @NonNull XPFCustomer customer, @NonNull List<XPFOrderItem> lineItems, @NonNull List<XPFOrderShipment> shipments, @NonNull XPFAddress billingAddress, XPFContact billingContact, @NonNull Map<String,String> modifierFields, BigDecimal subtotal, BigDecimal shipping, BigDecimal taxes, @NonNull BigDecimal total, @NonNull Set<XPFPayment> payments, String taxExemptionId, @NonNull Set<XPFOrderPaymentInstrument> orderPaymentInstruments, boolean hasSubtotalDiscount, @NonNull List<XPFOrderHold> holds, @NonNull XPFEntitySupplier<XPFContainerPricing> pricing)

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
XPFCustomer	getAccount() The account.
@NonNull XPFAddress	getBillingAddress() The billing address.
XPFContact	getBillingContact() The billing contact.
@NonNull Date	getCreatedDate() The date created.
@NonNull Currency	getCurrency() The currency.
@NonNull XPFCustomer	getCustomer() The customer.
@NonNull List<XPFOrderHold>	getHolds() The order holds.
@NonNull List<XPFOrderItem>	getLineItems() The line items.
Locale	getLocale() The locale.
@NonNull Map<String,String>	getModifierFields() The modifier fields.
@NonNull String	getOrderNumber() The order number.
@NonNull Set<XPFOrderPaymentInstrument>	getOrderPaymentInstruments() The order payment instruments.
@NonNull Set<XPFPayment>	getPayments() The payments.
XPFContainerPricing	getPricing() The order price calculator.
@NonNull List<XPFOrderShipment>	getShipments() The shipments.
BigDecimal	getShipping() Deprecated. use getPricing().withShippingSubtotal().getAmount() instead
@NonNull XPFOrderStatusEnum	getStatus() The order status.
@NonNull XPFStore	getStore() The store.
BigDecimal	getSubtotal() Deprecated. use getPricing().withSubtotal().getAmount() instead
BigDecimal	getTaxes() Deprecated. use getPricing().withTaxes().getAmount() instead
String	getTaxExemptionId() The tax exemption id.
@NonNull BigDecimal	getTotal() Deprecated. use getPricing().withTotal().getAmount() instead
int	hashCode()
boolean	isHasSubtotalDiscount() Indicates if the order has a subtotal discount.
String	toString()

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

getCustomData

Methods inherited from class java.lang.Object

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

Constructor Detail

XPFOrder

public XPFOrder(@NonNull
                @NonNull String orderNumber,
                @NonNull
                @NonNull Date createdDate,
                Locale locale,
                @NonNull
                @NonNull Currency currency,
                @NonNull
                @NonNull XPFOrderStatusEnum status,
                @NonNull
                @NonNull XPFStore store,
                XPFCustomer account,
                @NonNull
                @NonNull XPFCustomer customer,
                @NonNull
                @NonNull List<XPFOrderItem> lineItems,
                @NonNull
                @NonNull List<XPFOrderShipment> shipments,
                @NonNull
                @NonNull XPFAddress billingAddress,
                XPFContact billingContact,
                @NonNull
                @NonNull Map<String,String> modifierFields,
                BigDecimal subtotal,
                BigDecimal shipping,
                BigDecimal taxes,
                @NonNull
                @NonNull BigDecimal total,
                @NonNull
                @NonNull Set<XPFPayment> payments,
                String taxExemptionId,
                @NonNull
                @NonNull Set<XPFOrderPaymentInstrument> orderPaymentInstruments,
                boolean hasSubtotalDiscount,
                @NonNull
                @NonNull List<XPFOrderHold> holds,
                @NonNull
                @NonNull XPFEntitySupplier<XPFContainerPricing> pricing)

Method Detail

getPricing

@LazyLoaded
public XPFContainerPricing getPricing()

The order price calculator.

Returns:

the price calculator

getOrderNumber

@NonNull
public @NonNull String getOrderNumber()

The order number.

getCreatedDate

@NonNull
public @NonNull Date getCreatedDate()

The date created.

getLocale

public Locale getLocale()

The locale.

getCurrency

@NonNull
public @NonNull Currency getCurrency()

The currency.

getStatus

@NonNull
public @NonNull XPFOrderStatusEnum getStatus()

The order status.

getStore

@NonNull
public @NonNull XPFStore getStore()

The store.

getAccount

public XPFCustomer getAccount()

The account.

getCustomer

@NonNull
public @NonNull XPFCustomer getCustomer()

The customer.

getLineItems

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

The line items.

getShipments

@NonNull
public @NonNull List<XPFOrderShipment> getShipments()

The shipments.

getBillingAddress

@NonNull
public @NonNull XPFAddress getBillingAddress()

The billing address.

getBillingContact

public XPFContact getBillingContact()

The billing contact.

getModifierFields

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

The modifier fields.

getSubtotal

@Deprecated
public BigDecimal getSubtotal()

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

The subtotal.

getShipping

@Deprecated
public BigDecimal getShipping()

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

The shipping cost.

getTaxes

@Deprecated
public BigDecimal getTaxes()

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

The tax total.

getTotal

@Deprecated
 @NonNull
public @NonNull BigDecimal getTotal()

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

The order total.

getPayments

@NonNull
public @NonNull Set<XPFPayment> getPayments()

The payments.

getTaxExemptionId

public String getTaxExemptionId()

The tax exemption id.

getOrderPaymentInstruments

@NonNull
public @NonNull Set<XPFOrderPaymentInstrument> getOrderPaymentInstruments()

The order payment instruments.

isHasSubtotalDiscount

public boolean isHasSubtotalDiscount()

Indicates if the order has a subtotal discount.

getHolds

@NonNull
public @NonNull List<XPFOrderHold> getHolds()

The order holds.

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

toString

public String toString()

Overrides:

toString in class XPFEntity