Package com.commercetools.api.models.message

Interface OrderEstimatedDeliverySetMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface OrderEstimatedDeliverySetMessagePayload
extends OrderMessagePayload

Generated after a successful Set Estimated Delivery update action.

Example to create an instance using the builder pattern

     OrderEstimatedDeliverySetMessagePayload orderEstimatedDeliverySetMessagePayload = OrderEstimatedDeliverySetMessagePayload.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_ESTIMATED_DELIVERY_SET	discriminator value for OrderEstimatedDeliverySetMessagePayload

Method Summary

Modifier and Type	Method	Description
static OrderEstimatedDeliverySetMessagePayloadBuilder	builder()	builder factory method for OrderEstimatedDeliverySetMessagePayload
static OrderEstimatedDeliverySetMessagePayloadBuilder	builder(OrderEstimatedDeliverySetMessagePayload template)	create builder for OrderEstimatedDeliverySetMessagePayload instance
OrderEstimatedDeliverySetMessagePayload	copyDeep()
static OrderEstimatedDeliverySetMessagePayload	deepCopy(OrderEstimatedDeliverySetMessagePayload template)	factory method to create a deep copy of OrderEstimatedDeliverySetMessagePayload
@Valid EstimatedDelivery	getEstimatedDelivery()	Estimated delivery window on the Order after the Set Estimated Delivery update action.
String	getShippingKey()	key of the Shipping that was updated.
static OrderEstimatedDeliverySetMessagePayload	of()	factory method
static OrderEstimatedDeliverySetMessagePayload	of(OrderEstimatedDeliverySetMessagePayload template)	factory method to create a shallow copy OrderEstimatedDeliverySetMessagePayload
void	setEstimatedDelivery(EstimatedDelivery estimatedDelivery)	Estimated delivery window on the Order after the Set Estimated Delivery update action.
void	setShippingKey(String shippingKey)	key of the Shipping that was updated.
static tools.jackson.core.type.TypeReference<OrderEstimatedDeliverySetMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderEstimatedDeliverySetMessagePayload(Function<OrderEstimatedDeliverySetMessagePayload,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

ORDER_ESTIMATED_DELIVERY_SET

static final String ORDER_ESTIMATED_DELIVERY_SET

discriminator value for OrderEstimatedDeliverySetMessagePayload

See Also:

• Constant Field Values

Method Details

getEstimatedDelivery

@Valid
@Valid EstimatedDelivery getEstimatedDelivery()

Estimated delivery window on the Order after the Set Estimated Delivery update action.

Returns:

estimatedDelivery

getShippingKey

String getShippingKey()

key of the Shipping that was updated. Only present for Orders with Multiple ShippingMode.

Returns:

shippingKey

setEstimatedDelivery

void setEstimatedDelivery(EstimatedDelivery estimatedDelivery)

Estimated delivery window on the Order after the Set Estimated Delivery update action.

Parameters:

estimatedDelivery - value to be set

setShippingKey

void setShippingKey(String shippingKey)

key of the Shipping that was updated. Only present for Orders with Multiple ShippingMode.

Parameters:

shippingKey - value to be set

of

static OrderEstimatedDeliverySetMessagePayload of()

factory method

Returns:

instance of OrderEstimatedDeliverySetMessagePayload

of

static OrderEstimatedDeliverySetMessagePayload of(OrderEstimatedDeliverySetMessagePayload template)

factory method to create a shallow copy OrderEstimatedDeliverySetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderEstimatedDeliverySetMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

Specified by:

copyDeep in interface OrderMessagePayload

deepCopy

@Nullable
static OrderEstimatedDeliverySetMessagePayload deepCopy(@Nullable
 OrderEstimatedDeliverySetMessagePayload template)

factory method to create a deep copy of OrderEstimatedDeliverySetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderEstimatedDeliverySetMessagePayloadBuilder builder()

builder factory method for OrderEstimatedDeliverySetMessagePayload

Returns:

builder

builder

static OrderEstimatedDeliverySetMessagePayloadBuilder builder(OrderEstimatedDeliverySetMessagePayload template)

create builder for OrderEstimatedDeliverySetMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderEstimatedDeliverySetMessagePayload

default <T> T withOrderEstimatedDeliverySetMessagePayload(Function<OrderEstimatedDeliverySetMessagePayload,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static tools.jackson.core.type.TypeReference<OrderEstimatedDeliverySetMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference