Package com.commercetools.api.models.message

Interface DeliveryAddedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface DeliveryAddedMessagePayload
extends OrderMessagePayload

Generated after a successful Add Delivery update action.

Example to create an instance using the builder pattern

     DeliveryAddedMessagePayload deliveryAddedMessagePayload = DeliveryAddedMessagePayload.builder()
             .delivery(deliveryBuilder -> deliveryBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DELIVERY_ADDED	discriminator value for DeliveryAddedMessagePayload

Method Summary

Modifier and Type	Method	Description
static DeliveryAddedMessagePayloadBuilder	builder()	builder factory method for DeliveryAddedMessagePayload
static DeliveryAddedMessagePayloadBuilder	builder(DeliveryAddedMessagePayload template)	create builder for DeliveryAddedMessagePayload instance
DeliveryAddedMessagePayload	copyDeep()
static DeliveryAddedMessagePayload	deepCopy(DeliveryAddedMessagePayload template)	factory method to create a deep copy of DeliveryAddedMessagePayload
@NotNull @Valid Delivery	getDelivery()	Delivery that was added to the Order.
String	getShippingKey()	User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
static DeliveryAddedMessagePayload	of()	factory method
static DeliveryAddedMessagePayload	of(DeliveryAddedMessagePayload template)	factory method to create a shallow copy DeliveryAddedMessagePayload
void	setDelivery(Delivery delivery)	Delivery that was added to the Order.
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<DeliveryAddedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withDeliveryAddedMessagePayload(Function<DeliveryAddedMessagePayload,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_ADDED

static final String DELIVERY_ADDED

discriminator value for DeliveryAddedMessagePayload

See Also:

• Constant Field Values

Method Details

getDelivery

@NotNull
@Valid
@NotNull @Valid Delivery getDelivery()

Delivery that was added to the Order. The Delivery in the Message body does not contain Parcels if those were part of the initial Add Delivery update action. In that case, the update action produces an additional Parcel Added To Delivery Message containing information about the Parcels.

Returns:

delivery

getShippingKey

String getShippingKey()

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

Returns:

shippingKey

setDelivery

void setDelivery(Delivery delivery)

Delivery that was added to the Order. The Delivery in the Message body does not contain Parcels if those were part of the initial Add Delivery update action. In that case, the update action produces an additional Parcel Added To Delivery Message containing information about the Parcels.

Parameters:

delivery - value 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 DeliveryAddedMessagePayload of()

factory method

Returns:

instance of DeliveryAddedMessagePayload

of

static DeliveryAddedMessagePayload of(DeliveryAddedMessagePayload template)

factory method to create a shallow copy DeliveryAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

DeliveryAddedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

Specified by:

copyDeep in interface OrderMessagePayload

deepCopy

@Nullable
static DeliveryAddedMessagePayload deepCopy(@Nullable
 DeliveryAddedMessagePayload template)

factory method to create a deep copy of DeliveryAddedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static DeliveryAddedMessagePayloadBuilder builder()

builder factory method for DeliveryAddedMessagePayload

Returns:

builder

builder

static DeliveryAddedMessagePayloadBuilder builder(DeliveryAddedMessagePayload template)

create builder for DeliveryAddedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withDeliveryAddedMessagePayload

default <T> T withDeliveryAddedMessagePayload(Function<DeliveryAddedMessagePayload,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<DeliveryAddedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference