Package com.commercetools.api.models.order

Class OrderFromCartDraftBuilder

java.lang.Object

com.commercetools.api.models.order.OrderFromCartDraftBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<OrderFromCartDraft>

public class OrderFromCartDraftBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<OrderFromCartDraft>

OrderFromCartDraftBuilder Example to create an instance using the builder pattern

     OrderFromCartDraft orderFromCartDraft = OrderFromCartDraft.builder()
             .version(0.3)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
OrderFromCartDraftBuilder()

Method Summary

Modifier and Type	Method	Description
OrderFromCartDraft	build()	builds OrderFromCartDraft with checking for non-null required values
OrderFromCartDraft	buildUnchecked()	builds OrderFromCartDraft without checking for non-null required values
OrderFromCartDraftBuilder	cart(CartResourceIdentifier cart)	ResourceIdentifier of the Cart from which the Order is created.
OrderFromCartDraftBuilder	cart(Function<CartResourceIdentifierBuilder,CartResourceIdentifierBuilder> builder)	ResourceIdentifier of the Cart from which the Order is created.
OrderFromCartDraftBuilder	custom(CustomFieldsDraft custom)	Custom Fields for the Order.
OrderFromCartDraftBuilder	custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)	Custom Fields for the Order.
CartResourceIdentifier	getCart()	ResourceIdentifier of the Cart from which the Order is created.
CustomFieldsDraft	getCustom()	Custom Fields for the Order.
String	getId()	Deprecated.
String	getOrderNumber()	String that uniquely identifies an order.
OrderState	getOrderState()	Order will be created with Open status by default.
PaymentState	getPaymentState()	Payment state for the Order.
String	getPurchaseOrderNumber()	Identifier for a purchase order, usually in a B2B context.
ShipmentState	getShipmentState()	Shipment state for the Order.
StateResourceIdentifier	getState()	Reference to a State indicating the Order's state.
Long	getVersion()	Expected version of the Cart from which the Order is created.
OrderFromCartDraftBuilder	id(String id)	Deprecated.
static OrderFromCartDraftBuilder	of()	factory method for an instance of OrderFromCartDraftBuilder
static OrderFromCartDraftBuilder	of(OrderFromCartDraft template)	create builder for OrderFromCartDraft instance
OrderFromCartDraftBuilder	orderNumber(String orderNumber)	String that uniquely identifies an order.
OrderFromCartDraftBuilder	orderState(OrderState orderState)	Order will be created with Open status by default.
OrderFromCartDraftBuilder	paymentState(PaymentState paymentState)	Payment state for the Order.
OrderFromCartDraftBuilder	purchaseOrderNumber(String purchaseOrderNumber)	Identifier for a purchase order, usually in a B2B context.
OrderFromCartDraftBuilder	shipmentState(ShipmentState shipmentState)	Shipment state for the Order.
OrderFromCartDraftBuilder	state(StateResourceIdentifier state)	Reference to a State indicating the Order's state.
OrderFromCartDraftBuilder	state(Function<StateResourceIdentifierBuilder,StateResourceIdentifierBuilder> builder)	Reference to a State indicating the Order's state.
OrderFromCartDraftBuilder	version(Long version)	Expected version of the Cart from which the Order is created.
OrderFromCartDraftBuilder	withCart(Function<CartResourceIdentifierBuilder,CartResourceIdentifier> builder)	ResourceIdentifier of the Cart from which the Order is created.
OrderFromCartDraftBuilder	withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)	Custom Fields for the Order.
OrderFromCartDraftBuilder	withState(Function<StateResourceIdentifierBuilder,StateResourceIdentifier> builder)	Reference to a State indicating the Order's state.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OrderFromCartDraftBuilder

public OrderFromCartDraftBuilder()

Method Details

id

@Deprecated
public OrderFromCartDraftBuilder id(@Nullable
 String id)

Deprecated.

Unique identifier of the Cart from which you can create an Order.

Parameters:

id - value to be set

Returns:

Builder

cart

public OrderFromCartDraftBuilder cart(Function<CartResourceIdentifierBuilder,CartResourceIdentifierBuilder> builder)

ResourceIdentifier of the Cart from which the Order is created.

Parameters:

builder - function to build the cart value

Returns:

Builder

withCart

public OrderFromCartDraftBuilder withCart(Function<CartResourceIdentifierBuilder,CartResourceIdentifier> builder)

ResourceIdentifier of the Cart from which the Order is created.

Parameters:

builder - function to build the cart value

Returns:

Builder

cart

public OrderFromCartDraftBuilder cart(@Nullable
 CartResourceIdentifier cart)

ResourceIdentifier of the Cart from which the Order is created.

Parameters:

cart - value to be set

Returns:

Builder

version

public OrderFromCartDraftBuilder version(Long version)

Expected version of the Cart from which the Order is created. If the expected version does not match the actual version, a 409 Conflict error will be returned.

Parameters:

version - value to be set

Returns:

Builder

orderNumber

public OrderFromCartDraftBuilder orderNumber(@Nullable
 String orderNumber)

String that uniquely identifies an order. It can be used to create more human-readable (in contrast to ID) identifier for the order. It should be unique across a project. Once it's set it cannot be changed. For easier use on Get, Update and Delete actions we suggest assigning order numbers that match the regular expression [a-z0-9_\-]{2,36}.

Parameters:

orderNumber - value to be set

Returns:

Builder

purchaseOrderNumber

public OrderFromCartDraftBuilder purchaseOrderNumber(@Nullable
 String purchaseOrderNumber)

Identifier for a purchase order, usually in a B2B context. The Purchase Order Number is typically entered by the Buyer and can also be used with Quotes.

Parameters:

purchaseOrderNumber - value to be set

Returns:

Builder

paymentState

public OrderFromCartDraftBuilder paymentState(@Nullable
 PaymentState paymentState)

Payment state for the Order.

Parameters:

paymentState - value to be set

Returns:

Builder

shipmentState

public OrderFromCartDraftBuilder shipmentState(@Nullable
 ShipmentState shipmentState)

Shipment state for the Order.

Parameters:

shipmentState - value to be set

Returns:

Builder

orderState

public OrderFromCartDraftBuilder orderState(@Nullable
 OrderState orderState)

Order will be created with Open status by default.

Parameters:

orderState - value to be set

Returns:

Builder

state

public OrderFromCartDraftBuilder state(Function<StateResourceIdentifierBuilder,StateResourceIdentifierBuilder> builder)

Reference to a State indicating the Order's state.

Parameters:

builder - function to build the state value

Returns:

Builder

withState

public OrderFromCartDraftBuilder withState(Function<StateResourceIdentifierBuilder,StateResourceIdentifier> builder)

Reference to a State indicating the Order's state.

Parameters:

builder - function to build the state value

Returns:

Builder

state

public OrderFromCartDraftBuilder state(@Nullable
 StateResourceIdentifier state)

Reference to a State indicating the Order's state.

Parameters:

state - value to be set

Returns:

Builder

custom

public OrderFromCartDraftBuilder custom(Function<CustomFieldsDraftBuilder,CustomFieldsDraftBuilder> builder)

Custom Fields for the Order. The Custom Field type must match the type of the Custom Fields in the referenced Cart. If specified, the Custom Fields are merged with the Custom Fields on the referenced Cart and added to the Order. If empty, the Custom Fields on the referenced Cart are added to the Order automatically.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public OrderFromCartDraftBuilder withCustom(Function<CustomFieldsDraftBuilder,CustomFieldsDraft> builder)

Custom Fields for the Order. The Custom Field type must match the type of the Custom Fields in the referenced Cart. If specified, the Custom Fields are merged with the Custom Fields on the referenced Cart and added to the Order. If empty, the Custom Fields on the referenced Cart are added to the Order automatically.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public OrderFromCartDraftBuilder custom(@Nullable
 CustomFieldsDraft custom)

Custom Fields for the Order. The Custom Field type must match the type of the Custom Fields in the referenced Cart. If specified, the Custom Fields are merged with the Custom Fields on the referenced Cart and added to the Order. If empty, the Custom Fields on the referenced Cart are added to the Order automatically.

Parameters:

custom - value to be set

Returns:

Builder

getId

@Deprecated
@Nullable
public String getId()

Deprecated.

Unique identifier of the Cart from which you can create an Order.

Returns:

id

getCart

@Nullable
public CartResourceIdentifier getCart()

ResourceIdentifier of the Cart from which the Order is created.

Returns:

cart

getVersion

public Long getVersion()

Expected version of the Cart from which the Order is created. If the expected version does not match the actual version, a 409 Conflict error will be returned.

Returns:

version

getOrderNumber

@Nullable
public String getOrderNumber()

String that uniquely identifies an order. It can be used to create more human-readable (in contrast to ID) identifier for the order. It should be unique across a project. Once it's set it cannot be changed. For easier use on Get, Update and Delete actions we suggest assigning order numbers that match the regular expression [a-z0-9_\-]{2,36}.

Returns:

orderNumber

getPurchaseOrderNumber

@Nullable
public String getPurchaseOrderNumber()

Identifier for a purchase order, usually in a B2B context. The Purchase Order Number is typically entered by the Buyer and can also be used with Quotes.

Returns:

purchaseOrderNumber

getPaymentState

@Nullable
public PaymentState getPaymentState()

Payment state for the Order.

Returns:

paymentState

getShipmentState

@Nullable
public ShipmentState getShipmentState()

Shipment state for the Order.

Returns:

shipmentState

getOrderState

@Nullable
public OrderState getOrderState()

Order will be created with Open status by default.

Returns:

orderState

getState

@Nullable
public StateResourceIdentifier getState()

Reference to a State indicating the Order's state.

Returns:

state

getCustom

@Nullable
public CustomFieldsDraft getCustom()

Custom Fields for the Order. The Custom Field type must match the type of the Custom Fields in the referenced Cart. If specified, the Custom Fields are merged with the Custom Fields on the referenced Cart and added to the Order. If empty, the Custom Fields on the referenced Cart are added to the Order automatically.

Returns:

custom

build

public OrderFromCartDraft build()

builds OrderFromCartDraft with checking for non-null required values

Specified by:

build in interface io.vrap.rmf.base.client.Builder<OrderFromCartDraft>

Returns:

OrderFromCartDraft

buildUnchecked

public OrderFromCartDraft buildUnchecked()

builds OrderFromCartDraft without checking for non-null required values

Returns:

OrderFromCartDraft

of

public static OrderFromCartDraftBuilder of()

factory method for an instance of OrderFromCartDraftBuilder

Returns:

builder

of

public static OrderFromCartDraftBuilder of(OrderFromCartDraft template)

create builder for OrderFromCartDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder