Package com.commercetools.api.models.order

Interface OrderAddDeliveryAction

All Superinterfaces:

CustomizableDraft<OrderAddDeliveryAction>, OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

All Known Implementing Classes:

OrderAddDeliveryActionImpl

public interface OrderAddDeliveryAction
extends OrderUpdateAction, CustomizableDraft<OrderAddDeliveryAction>

OrderAddDeliveryAction Example to create an instance using the builder pattern

     OrderAddDeliveryAction orderAddDeliveryAction = OrderAddDeliveryAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_DELIVERY	discriminator value for OrderAddDeliveryAction

Method Summary

Modifier and Type	Method	Description
static OrderAddDeliveryActionBuilder	builder()	builder factory method for OrderAddDeliveryAction
static OrderAddDeliveryActionBuilder	builder(OrderAddDeliveryAction template)	create builder for OrderAddDeliveryAction instance
static OrderAddDeliveryAction	deepCopy(OrderAddDeliveryAction template)	factory method to create a deep copy of OrderAddDeliveryAction
@Valid BaseAddress	getAddress()	Polymorphic base type that represents a postal address and contact details.
@Valid CustomFieldsDraft	getCustom()	Custom Fields for the Transaction.
String	getDeliveryKey()	User-defined unique identifier of a Delivery.
@Valid List<DeliveryItem>	getItems()
@Valid List<ParcelDraft>	getParcels()
String	getShippingKey()	User-defined unique identifier of the Shipping Method in a Cart with Multi ShippingMode.
static OrderAddDeliveryAction	of()	factory method
static OrderAddDeliveryAction	of(OrderAddDeliveryAction template)	factory method to create a shallow copy OrderAddDeliveryAction
void	setAddress(BaseAddress address)	Polymorphic base type that represents a postal address and contact details.
void	setCustom(CustomFieldsDraft custom)	Custom Fields for the Transaction.
void	setDeliveryKey(String deliveryKey)	User-defined unique identifier of a Delivery.
void	setItems(DeliveryItem... items)	set items
void	setItems(List<DeliveryItem> items)	set items
void	setParcels(ParcelDraft... parcels)	set parcels
void	setParcels(List<ParcelDraft> parcels)	set parcels
void	setShippingKey(String shippingKey)	User-defined unique identifier of the Shipping Method in a Cart with Multi ShippingMode.
static com.fasterxml.jackson.core.type.TypeReference<OrderAddDeliveryAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderAddDeliveryAction(Function<OrderAddDeliveryAction,T> helper)	accessor map function

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

unwrapCustomizableDraft

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

getAction, withOrderUpdateAction

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

get

Field Details

ADD_DELIVERY

static final String ADD_DELIVERY

discriminator value for OrderAddDeliveryAction

See Also:

• Constant Field Values

Method Details

getDeliveryKey

String getDeliveryKey()

User-defined unique identifier of a Delivery.

Returns:

deliveryKey

getItems

@Valid
@Valid List<DeliveryItem> getItems()

Returns:

items

getShippingKey

String getShippingKey()

User-defined unique identifier of the Shipping Method in a Cart with Multi ShippingMode.

Returns:

shippingKey

getAddress

@Valid
@Valid BaseAddress getAddress()

Polymorphic base type that represents a postal address and contact details. Depending on the read or write action, it can be either Address or AddressDraft that only differ in the data type for the optional custom field.

Returns:

address

getParcels

@Valid
@Valid List<ParcelDraft> getParcels()

Returns:

parcels

getCustom

@Valid
@Valid CustomFieldsDraft getCustom()

Custom Fields for the Transaction.

Specified by:

getCustom in interface CustomizableDraft<OrderAddDeliveryAction>

Returns:

custom

setDeliveryKey

void setDeliveryKey(String deliveryKey)

User-defined unique identifier of a Delivery.

Parameters:

deliveryKey - value to be set

setItems

void setItems(DeliveryItem... items)

set items

Parameters:

items - values to be set

setItems

void setItems(List<DeliveryItem> items)

set items

Parameters:

items - values to be set

setShippingKey

void setShippingKey(String shippingKey)

User-defined unique identifier of the Shipping Method in a Cart with Multi ShippingMode.

Parameters:

shippingKey - value to be set

setAddress

void setAddress(BaseAddress address)

Polymorphic base type that represents a postal address and contact details. Depending on the read or write action, it can be either Address or AddressDraft that only differ in the data type for the optional custom field.

Parameters:

address - value to be set

setParcels

void setParcels(ParcelDraft... parcels)

set parcels

Parameters:

parcels - values to be set

setParcels

void setParcels(List<ParcelDraft> parcels)

set parcels

Parameters:

parcels - values to be set

setCustom

void setCustom(CustomFieldsDraft custom)

Custom Fields for the Transaction.

Specified by:

setCustom in interface CustomizableDraft<OrderAddDeliveryAction>

Parameters:

custom - value to be set

of

static OrderAddDeliveryAction of()

factory method

Returns:

instance of OrderAddDeliveryAction

of

static OrderAddDeliveryAction of(OrderAddDeliveryAction template)

factory method to create a shallow copy OrderAddDeliveryAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderAddDeliveryAction deepCopy(@Nullable
 OrderAddDeliveryAction template)

factory method to create a deep copy of OrderAddDeliveryAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderAddDeliveryActionBuilder builder()

builder factory method for OrderAddDeliveryAction

Returns:

builder

builder

static OrderAddDeliveryActionBuilder builder(OrderAddDeliveryAction template)

create builder for OrderAddDeliveryAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderAddDeliveryAction

default <T> T withOrderAddDeliveryAction(Function<OrderAddDeliveryAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<OrderAddDeliveryAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference