Package com.commercetools.api.models.order

Class OrderImportDraftImpl

java.lang.Object

com.commercetools.api.models.order.OrderImportDraftImpl

All Implemented Interfaces:

CustomizableDraft<OrderImportDraft>, OrderImportDraft, io.vrap.rmf.base.client.Draft<OrderImportDraft>, io.vrap.rmf.base.client.ModelBase

public class OrderImportDraftImpl
extends Object
implements OrderImportDraft, io.vrap.rmf.base.client.ModelBase

A snapshot of an Order at the time it was imported.

Nested Class Summary

Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase

io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle

Constructor Summary

Constructors

Constructor	Description
OrderImportDraftImpl()	create empty instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
BaseAddress	getBillingAddress()	Billing address associated with the Order.
BusinessUnitResourceIdentifier	getBusinessUnit()	ResourceIdentifier to the Business Unit the Order should belong to.
ZonedDateTime	getCompletedAt()	User-defined date and time for the Order.
String	getCountry()	Include a value to associate a country with the Order.
CustomFieldsDraft	getCustom()	Custom Fields for the Order.
String	getCustomerEmail()	The Email address of the Customer the Order belongs to.
CustomerGroupResourceIdentifier	getCustomerGroup()	The Customer Group of the Customer the Order belongs to.
String	getCustomerId()	The id of the Customer the Order belongs to.
List<CustomLineItemImportDraft>	getCustomLineItems()	Custom Line Items to add to the Cart.
InventoryMode	getInventoryMode()	Determines how stock quantities are tracked for Line Items in the Cart.
List<BaseAddress>	getItemShippingAddresses()	Addresses for Orders with multiple shipping addresses.
List<LineItemImportDraft>	getLineItems()	Line Items to add to the Order.
String	getOrderNumber()	User-defined identifier of the Order.
OrderState	getOrderState()	Current status of the Order.
CartOrigin	getOrigin()	Indicates the origin of the Order.
PaymentInfo	getPaymentInfo()	Payment information associated with the Order.
PaymentState	getPaymentState()	Payment status of the Order.
String	getPurchaseOrderNumber()	User-defined identifier for a purchase Order.
ShipmentState	getShipmentState()	Shipment status of the Order.
BaseAddress	getShippingAddress()	Shipping address associated with the Order.
ShippingInfoImportDraft	getShippingInfo()	Shipping-related information of the Order.
StateReference	getState()	State of the Order in a custom workflow.
StoreResourceIdentifier	getStore()	The Store the Order belongs to.
TaxCalculationMode	getTaxCalculationMode()	Determines how taxes are calculated for taxedPrice.
TaxedPriceDraft	getTaxedPrice()	Include TaxedPrice information for the Order.
RoundingMode	getTaxRoundingMode()	Determines how monetary values are rounded when calculating taxes for taxedPrice.
Money	getTotalPrice()	The total Price of the Order.
int	hashCode()
void	setBillingAddress(BaseAddress billingAddress)	Billing address associated with the Order.
void	setBusinessUnit(BusinessUnitResourceIdentifier businessUnit)	ResourceIdentifier to the Business Unit the Order should belong to.
void	setCompletedAt(ZonedDateTime completedAt)	User-defined date and time for the Order.
void	setCountry(String country)	Include a value to associate a country with the Order.
void	setCustom(CustomFieldsDraft custom)	Custom Fields for the Order.
void	setCustomerEmail(String customerEmail)	The Email address of the Customer the Order belongs to.
void	setCustomerGroup(CustomerGroupResourceIdentifier customerGroup)	The Customer Group of the Customer the Order belongs to.
void	setCustomerId(String customerId)	The id of the Customer the Order belongs to.
void	setCustomLineItems(CustomLineItemImportDraft... customLineItems)	Custom Line Items to add to the Cart.
void	setCustomLineItems(List<CustomLineItemImportDraft> customLineItems)	Custom Line Items to add to the Cart.
void	setInventoryMode(InventoryMode inventoryMode)	Determines how stock quantities are tracked for Line Items in the Cart.
void	setItemShippingAddresses(BaseAddress... itemShippingAddresses)	Addresses for Orders with multiple shipping addresses.
void	setItemShippingAddresses(List<BaseAddress> itemShippingAddresses)	Addresses for Orders with multiple shipping addresses.
void	setLineItems(LineItemImportDraft... lineItems)	Line Items to add to the Order.
void	setLineItems(List<LineItemImportDraft> lineItems)	Line Items to add to the Order.
void	setOrderNumber(String orderNumber)	User-defined identifier of the Order.
void	setOrderState(OrderState orderState)	Current status of the Order.
void	setOrigin(CartOrigin origin)	Indicates the origin of the Order.
void	setPaymentInfo(PaymentInfo paymentInfo)	Payment information associated with the Order.
void	setPaymentState(PaymentState paymentState)	Payment status of the Order.
void	setPurchaseOrderNumber(String purchaseOrderNumber)	User-defined identifier for a purchase Order.
void	setShipmentState(ShipmentState shipmentState)	Shipment status of the Order.
void	setShippingAddress(BaseAddress shippingAddress)	Shipping address associated with the Order.
void	setShippingInfo(ShippingInfoImportDraft shippingInfo)	Shipping-related information of the Order.
void	setState(StateReference state)	State of the Order in a custom workflow.
void	setStore(StoreResourceIdentifier store)	The Store the Order belongs to.
void	setTaxCalculationMode(TaxCalculationMode taxCalculationMode)	Determines how taxes are calculated for taxedPrice.
void	setTaxedPrice(TaxedPriceDraft taxedPrice)	Include TaxedPrice information for the Order.
void	setTaxRoundingMode(RoundingMode taxRoundingMode)	Determines how monetary values are rounded when calculating taxes for taxedPrice.
void	setTotalPrice(Money totalPrice)	The total Price of the Order.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.commercetools.api.models.CustomizableDraft

unwrapCustomizableDraft

Methods inherited from interface io.vrap.rmf.base.client.ModelBase

reflectionString, reflectionString

Methods inherited from interface com.commercetools.api.models.order.OrderImportDraft

withOrderImportDraft

Constructor Details

OrderImportDraftImpl

public OrderImportDraftImpl()

create empty instance

Method Details

getOrderNumber

public String getOrderNumber()

User-defined identifier of the Order. Must be unique across a Project. Once set, the value cannot be changed.

Specified by:

getOrderNumber in interface OrderImportDraft

Returns:

orderNumber

getPurchaseOrderNumber

public String getPurchaseOrderNumber()

User-defined identifier for a purchase Order.

Specified by:

getPurchaseOrderNumber in interface OrderImportDraft

Returns:

purchaseOrderNumber

getCustomerId

public String getCustomerId()

The id of the Customer the Order belongs to.

Specified by:

getCustomerId in interface OrderImportDraft

Returns:

customerId

getCustomerEmail

public String getCustomerEmail()

The Email address of the Customer the Order belongs to. Can be used instead of customerId when no check against existing Customers is required.

Specified by:

getCustomerEmail in interface OrderImportDraft

Returns:

customerEmail

getCustomerGroup

public CustomerGroupResourceIdentifier getCustomerGroup()

The Customer Group of the Customer the Order belongs to.

Specified by:

getCustomerGroup in interface OrderImportDraft

Returns:

customerGroup

getBusinessUnit

public BusinessUnitResourceIdentifier getBusinessUnit()

ResourceIdentifier to the Business Unit the Order should belong to. When the customerId of the Order is also set, the Customer must be an Associate of the Business Unit.

Specified by:

getBusinessUnit in interface OrderImportDraft

Returns:

businessUnit

getStore

public StoreResourceIdentifier getStore()

The Store the Order belongs to. Used for filtering.

If a LineItemImportDraft or a CustomLineItemImportDraft specifies a distributionChannel or a supplyChannel that is not defined for the referenced Store, the Order Import gets rejected. The same applies when the provided country is not defined for the referenced Store.

Specified by:

getStore in interface OrderImportDraft

Returns:

store

getLineItems

public List<LineItemImportDraft> getLineItems()

Line Items to add to the Order.

If not specified, customLineItems must not be empty.

Specified by:

getLineItems in interface OrderImportDraft

Returns:

lineItems

getCustomLineItems

public List<CustomLineItemImportDraft> getCustomLineItems()

Custom Line Items to add to the Cart.

If not specified, lineItems must not be empty.

Specified by:

getCustomLineItems in interface OrderImportDraft

Returns:

customLineItems

getTotalPrice

public Money getTotalPrice()

The total Price of the Order. The amount can be negative.

Specified by:

getTotalPrice in interface OrderImportDraft

Returns:

totalPrice

getTaxedPrice

public TaxedPriceDraft getTaxedPrice()

Include TaxedPrice information for the Order. If not included, and if you have Tax Rates set for Line Items and Custom Line Items, the Order total will not be recalculated.

Specified by:

getTaxedPrice in interface OrderImportDraft

Returns:

taxedPrice

getTaxRoundingMode

public RoundingMode getTaxRoundingMode()

Determines how monetary values are rounded when calculating taxes for taxedPrice.

Specified by:

getTaxRoundingMode in interface OrderImportDraft

Returns:

taxRoundingMode

getTaxCalculationMode

public TaxCalculationMode getTaxCalculationMode()

Determines how taxes are calculated for taxedPrice.

Specified by:

getTaxCalculationMode in interface OrderImportDraft

Returns:

taxCalculationMode

getInventoryMode

public InventoryMode getInventoryMode()

Determines how stock quantities are tracked for Line Items in the Cart.

Specified by:

getInventoryMode in interface OrderImportDraft

Returns:

inventoryMode

getBillingAddress

public BaseAddress getBillingAddress()

Billing address associated with the Order.

Specified by:

getBillingAddress in interface OrderImportDraft

Returns:

billingAddress

getShippingAddress

public BaseAddress getShippingAddress()

Shipping address associated with the Order.

Specified by:

getShippingAddress in interface OrderImportDraft

Returns:

shippingAddress

getItemShippingAddresses

public List<BaseAddress> getItemShippingAddresses()

Addresses for Orders with multiple shipping addresses. Addresses must include a value for key.

Specified by:

getItemShippingAddresses in interface OrderImportDraft

Returns:

itemShippingAddresses

getShippingInfo

public ShippingInfoImportDraft getShippingInfo()

Shipping-related information of the Order.

Specified by:

getShippingInfo in interface OrderImportDraft

Returns:

shippingInfo

getPaymentInfo

public PaymentInfo getPaymentInfo()

Payment information associated with the Order.

Specified by:

getPaymentInfo in interface OrderImportDraft

Returns:

paymentInfo

getPaymentState

public PaymentState getPaymentState()

Payment status of the Order.

Specified by:

getPaymentState in interface OrderImportDraft

Returns:

paymentState

getShipmentState

public ShipmentState getShipmentState()

Shipment status of the Order.

Specified by:

getShipmentState in interface OrderImportDraft

Returns:

shipmentState

getOrderState

public OrderState getOrderState()

Current status of the Order.

Specified by:

getOrderState in interface OrderImportDraft

Returns:

orderState

getState

public StateReference getState()

State of the Order in a custom workflow.

Specified by:

getState in interface OrderImportDraft

Returns:

state

getCountry

public String getCountry()

Include a value to associate a country with the Order.

Specified by:

getCountry in interface OrderImportDraft

Returns:

country

getOrigin

public CartOrigin getOrigin()

Indicates the origin of the Order.

Specified by:

getOrigin in interface OrderImportDraft

Returns:

origin

getCompletedAt

public ZonedDateTime getCompletedAt()

User-defined date and time for the Order. This value does not influence the createdAt or lastModifiedAt values of the Order created by the Order Import.

Specified by:

getCompletedAt in interface OrderImportDraft

Returns:

completedAt

getCustom

public CustomFieldsDraft getCustom()

Custom Fields for the Order.

Specified by:

getCustom in interface CustomizableDraft<OrderImportDraft>

Specified by:

getCustom in interface OrderImportDraft

Returns:

custom

setOrderNumber

public void setOrderNumber(String orderNumber)

Description copied from interface: OrderImportDraft

User-defined identifier of the Order. Must be unique across a Project. Once set, the value cannot be changed.

Specified by:

setOrderNumber in interface OrderImportDraft

Parameters:

orderNumber - value to be set

setPurchaseOrderNumber

public void setPurchaseOrderNumber(String purchaseOrderNumber)

Description copied from interface: OrderImportDraft

User-defined identifier for a purchase Order.

Specified by:

setPurchaseOrderNumber in interface OrderImportDraft

Parameters:

purchaseOrderNumber - value to be set

setCustomerId

public void setCustomerId(String customerId)

Description copied from interface: OrderImportDraft

The id of the Customer the Order belongs to.

Specified by:

setCustomerId in interface OrderImportDraft

Parameters:

customerId - value to be set

setCustomerEmail

public void setCustomerEmail(String customerEmail)

Description copied from interface: OrderImportDraft

The Email address of the Customer the Order belongs to. Can be used instead of customerId when no check against existing Customers is required.

Specified by:

setCustomerEmail in interface OrderImportDraft

Parameters:

customerEmail - value to be set

setCustomerGroup

public void setCustomerGroup(CustomerGroupResourceIdentifier customerGroup)

Description copied from interface: OrderImportDraft

The Customer Group of the Customer the Order belongs to.

Specified by:

setCustomerGroup in interface OrderImportDraft

Parameters:

customerGroup - value to be set

setBusinessUnit

public void setBusinessUnit(BusinessUnitResourceIdentifier businessUnit)

Description copied from interface: OrderImportDraft

ResourceIdentifier to the Business Unit the Order should belong to. When the customerId of the Order is also set, the Customer must be an Associate of the Business Unit.

Specified by:

setBusinessUnit in interface OrderImportDraft

Parameters:

businessUnit - value to be set

setStore

public void setStore(StoreResourceIdentifier store)

Description copied from interface: OrderImportDraft

The Store the Order belongs to. Used for filtering.

If a LineItemImportDraft or a CustomLineItemImportDraft specifies a distributionChannel or a supplyChannel that is not defined for the referenced Store, the Order Import gets rejected. The same applies when the provided country is not defined for the referenced Store.

Specified by:

setStore in interface OrderImportDraft

Parameters:

store - value to be set

setLineItems

public void setLineItems(LineItemImportDraft... lineItems)

Description copied from interface: OrderImportDraft

Line Items to add to the Order.

If not specified, customLineItems must not be empty.

Specified by:

setLineItems in interface OrderImportDraft

Parameters:

lineItems - values to be set

setLineItems

public void setLineItems(List<LineItemImportDraft> lineItems)

Description copied from interface: OrderImportDraft

Line Items to add to the Order.

If not specified, customLineItems must not be empty.

Specified by:

setLineItems in interface OrderImportDraft

Parameters:

lineItems - values to be set

setCustomLineItems

public void setCustomLineItems(CustomLineItemImportDraft... customLineItems)

Description copied from interface: OrderImportDraft

Custom Line Items to add to the Cart.

If not specified, lineItems must not be empty.

Specified by:

setCustomLineItems in interface OrderImportDraft

Parameters:

customLineItems - values to be set

setCustomLineItems

public void setCustomLineItems(List<CustomLineItemImportDraft> customLineItems)

Description copied from interface: OrderImportDraft

Custom Line Items to add to the Cart.

If not specified, lineItems must not be empty.

Specified by:

setCustomLineItems in interface OrderImportDraft

Parameters:

customLineItems - values to be set

setTotalPrice

public void setTotalPrice(Money totalPrice)

Description copied from interface: OrderImportDraft

The total Price of the Order. The amount can be negative.

Specified by:

setTotalPrice in interface OrderImportDraft

Parameters:

totalPrice - value to be set

setTaxedPrice

public void setTaxedPrice(TaxedPriceDraft taxedPrice)

Description copied from interface: OrderImportDraft

Include TaxedPrice information for the Order. If not included, and if you have Tax Rates set for Line Items and Custom Line Items, the Order total will not be recalculated.

Specified by:

setTaxedPrice in interface OrderImportDraft

Parameters:

taxedPrice - value to be set

setTaxRoundingMode

public void setTaxRoundingMode(RoundingMode taxRoundingMode)

Description copied from interface: OrderImportDraft

Determines how monetary values are rounded when calculating taxes for taxedPrice.

Specified by:

setTaxRoundingMode in interface OrderImportDraft

Parameters:

taxRoundingMode - value to be set

setTaxCalculationMode

public void setTaxCalculationMode(TaxCalculationMode taxCalculationMode)

Description copied from interface: OrderImportDraft

Determines how taxes are calculated for taxedPrice.

Specified by:

setTaxCalculationMode in interface OrderImportDraft

Parameters:

taxCalculationMode - value to be set

setInventoryMode

public void setInventoryMode(InventoryMode inventoryMode)

Description copied from interface: OrderImportDraft

Determines how stock quantities are tracked for Line Items in the Cart.

Specified by:

setInventoryMode in interface OrderImportDraft

Parameters:

inventoryMode - value to be set

setBillingAddress

public void setBillingAddress(BaseAddress billingAddress)

Description copied from interface: OrderImportDraft

Billing address associated with the Order.

Specified by:

setBillingAddress in interface OrderImportDraft

Parameters:

billingAddress - value to be set

setShippingAddress

public void setShippingAddress(BaseAddress shippingAddress)

Description copied from interface: OrderImportDraft

Shipping address associated with the Order.

Specified by:

setShippingAddress in interface OrderImportDraft

Parameters:

shippingAddress - value to be set

setItemShippingAddresses

public void setItemShippingAddresses(BaseAddress... itemShippingAddresses)

Description copied from interface: OrderImportDraft

Addresses for Orders with multiple shipping addresses. Addresses must include a value for key.

Specified by:

setItemShippingAddresses in interface OrderImportDraft

Parameters:

itemShippingAddresses - values to be set

setItemShippingAddresses

public void setItemShippingAddresses(List<BaseAddress> itemShippingAddresses)

Description copied from interface: OrderImportDraft

Addresses for Orders with multiple shipping addresses. Addresses must include a value for key.

Specified by:

setItemShippingAddresses in interface OrderImportDraft

Parameters:

itemShippingAddresses - values to be set

setShippingInfo

public void setShippingInfo(ShippingInfoImportDraft shippingInfo)

Description copied from interface: OrderImportDraft

Shipping-related information of the Order.

Specified by:

setShippingInfo in interface OrderImportDraft

Parameters:

shippingInfo - value to be set

setPaymentInfo

public void setPaymentInfo(PaymentInfo paymentInfo)

Description copied from interface: OrderImportDraft

Payment information associated with the Order.

Specified by:

setPaymentInfo in interface OrderImportDraft

Parameters:

paymentInfo - value to be set

setPaymentState

public void setPaymentState(PaymentState paymentState)

Description copied from interface: OrderImportDraft

Payment status of the Order.

Specified by:

setPaymentState in interface OrderImportDraft

Parameters:

paymentState - value to be set

setShipmentState

public void setShipmentState(ShipmentState shipmentState)

Description copied from interface: OrderImportDraft

Shipment status of the Order.

Specified by:

setShipmentState in interface OrderImportDraft

Parameters:

shipmentState - value to be set

setOrderState

public void setOrderState(OrderState orderState)

Description copied from interface: OrderImportDraft

Current status of the Order.

Specified by:

setOrderState in interface OrderImportDraft

Parameters:

orderState - value to be set

setState

public void setState(StateReference state)

Description copied from interface: OrderImportDraft

State of the Order in a custom workflow.

Specified by:

setState in interface OrderImportDraft

Parameters:

state - value to be set

setCountry

public void setCountry(String country)

Description copied from interface: OrderImportDraft

Include a value to associate a country with the Order.

Specified by:

setCountry in interface OrderImportDraft

Parameters:

country - value to be set

setOrigin

public void setOrigin(CartOrigin origin)

Description copied from interface: OrderImportDraft

Indicates the origin of the Order.

Specified by:

setOrigin in interface OrderImportDraft

Parameters:

origin - value to be set

setCompletedAt

public void setCompletedAt(ZonedDateTime completedAt)

Description copied from interface: OrderImportDraft

User-defined date and time for the Order. This value does not influence the createdAt or lastModifiedAt values of the Order created by the Order Import.

Specified by:

setCompletedAt in interface OrderImportDraft

Parameters:

completedAt - value to be set

setCustom

public void setCustom(CustomFieldsDraft custom)

Description copied from interface: OrderImportDraft

Custom Fields for the Order.

Specified by:

setCustom in interface CustomizableDraft<OrderImportDraft>

Specified by:

setCustom in interface OrderImportDraft

Parameters:

custom - value to be set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object