Package com.commercetools.api.models.message

Interface DeliveryItemsUpdatedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface DeliveryItemsUpdatedMessagePayload
extends OrderMessagePayload

Generated after a successful Set Delivery Items update action.

Example to create an instance using the builder pattern

     DeliveryItemsUpdatedMessagePayload deliveryItemsUpdatedMessagePayload = DeliveryItemsUpdatedMessagePayload.builder()
             .deliveryId("{deliveryId}")
             .plusItems(itemsBuilder -> itemsBuilder)
             .plusOldItems(oldItemsBuilder -> oldItemsBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DELIVERY_ITEMS_UPDATED	discriminator value for DeliveryItemsUpdatedMessagePayload

Method Summary

Modifier and Type	Method	Description
static DeliveryItemsUpdatedMessagePayloadBuilder	builder()	builder factory method for DeliveryItemsUpdatedMessagePayload
static DeliveryItemsUpdatedMessagePayloadBuilder	builder(DeliveryItemsUpdatedMessagePayload template)	create builder for DeliveryItemsUpdatedMessagePayload instance
DeliveryItemsUpdatedMessagePayload	copyDeep()
static DeliveryItemsUpdatedMessagePayload	deepCopy(DeliveryItemsUpdatedMessagePayload template)	factory method to create a deep copy of DeliveryItemsUpdatedMessagePayload
@NotNull String	getDeliveryId()	Unique identifier of the Delivery.
@NotNull @Valid List<DeliveryItem>	getItems()	Delivery Items after the Set Delivery Items update action.
@NotNull @Valid List<DeliveryItem>	getOldItems()	Delivery Items before the Set Delivery Items update action.
String	getShippingKey()	User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
static DeliveryItemsUpdatedMessagePayload	of()	factory method
static DeliveryItemsUpdatedMessagePayload	of(DeliveryItemsUpdatedMessagePayload template)	factory method to create a shallow copy DeliveryItemsUpdatedMessagePayload
void	setDeliveryId(String deliveryId)	Unique identifier of the Delivery.
void	setItems(DeliveryItem... items)	Delivery Items after the Set Delivery Items update action.
void	setItems(List<DeliveryItem> items)	Delivery Items after the Set Delivery Items update action.
void	setOldItems(DeliveryItem... oldItems)	Delivery Items before the Set Delivery Items update action.
void	setOldItems(List<DeliveryItem> oldItems)	Delivery Items before the Set Delivery Items update action.
void	setShippingKey(String shippingKey)	User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
static com.fasterxml.jackson.core.type.TypeReference<DeliveryItemsUpdatedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDeliveryItemsUpdatedMessagePayload(Function<DeliveryItemsUpdatedMessagePayload,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.message.MessagePayload

getType, withMessagePayload

Methods inherited from interface com.commercetools.api.models.message.MessagePayloadMixin

as

Methods inherited from interface com.commercetools.api.models.message.OrderMessagePayload

withOrderMessagePayload

Field Details

DELIVERY_ITEMS_UPDATED

static final String DELIVERY_ITEMS_UPDATED

discriminator value for DeliveryItemsUpdatedMessagePayload

See Also:

• Constant Field Values

Method Details

getDeliveryId

@NotNull
@NotNull String getDeliveryId()

Unique identifier of the Delivery.

Returns:

deliveryId

getItems

@NotNull
@Valid
@NotNull @Valid List<DeliveryItem> getItems()

Delivery Items after the Set Delivery Items update action.

Returns:

items

getOldItems

@NotNull
@Valid
@NotNull @Valid List<DeliveryItem> getOldItems()

Delivery Items before the Set Delivery Items update action.

Returns:

oldItems

getShippingKey

String getShippingKey()

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

Returns:

shippingKey

setDeliveryId

void setDeliveryId(String deliveryId)

Unique identifier of the Delivery.

Parameters:

deliveryId - value to be set

setItems

void setItems(DeliveryItem... items)

Delivery Items after the Set Delivery Items update action.

Parameters:

items - values to be set

setItems

void setItems(List<DeliveryItem> items)

Delivery Items after the Set Delivery Items update action.

Parameters:

items - values to be set

setOldItems

void setOldItems(DeliveryItem... oldItems)

Delivery Items before the Set Delivery Items update action.

Parameters:

oldItems - values to be set

setOldItems

void setOldItems(List<DeliveryItem> oldItems)

Delivery Items before the Set Delivery Items update action.

Parameters:

oldItems - values to be set

setShippingKey

void setShippingKey(String shippingKey)

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

Parameters:

shippingKey - value to be set

of

static DeliveryItemsUpdatedMessagePayload of()

factory method

Returns:

instance of DeliveryItemsUpdatedMessagePayload

of

static DeliveryItemsUpdatedMessagePayload of(DeliveryItemsUpdatedMessagePayload template)

factory method to create a shallow copy DeliveryItemsUpdatedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

DeliveryItemsUpdatedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

Specified by:

copyDeep in interface OrderMessagePayload

deepCopy

@Nullable
static DeliveryItemsUpdatedMessagePayload deepCopy(@Nullable
 DeliveryItemsUpdatedMessagePayload template)

factory method to create a deep copy of DeliveryItemsUpdatedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DeliveryItemsUpdatedMessagePayloadBuilder builder()

builder factory method for DeliveryItemsUpdatedMessagePayload

Returns:

builder

builder

static DeliveryItemsUpdatedMessagePayloadBuilder builder(DeliveryItemsUpdatedMessagePayload template)

create builder for DeliveryItemsUpdatedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDeliveryItemsUpdatedMessagePayload

default <T> T withDeliveryItemsUpdatedMessagePayload(Function<DeliveryItemsUpdatedMessagePayload,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<DeliveryItemsUpdatedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference