Package com.commercetools.api.models.message

Interface OrderShippingInfoSetMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface OrderShippingInfoSetMessagePayload
extends OrderMessagePayload

Generated after a successful Set ShippingMethod and Set Custom ShippingMethod update actions.

Example to create an instance using the builder pattern

     OrderShippingInfoSetMessagePayload orderShippingInfoSetMessagePayload = OrderShippingInfoSetMessagePayload.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_SHIPPING_INFO_SET	discriminator value for OrderShippingInfoSetMessagePayload

Method Summary

Modifier and Type	Method	Description
static OrderShippingInfoSetMessagePayloadBuilder	builder()	builder factory method for OrderShippingInfoSetMessagePayload
static OrderShippingInfoSetMessagePayloadBuilder	builder(OrderShippingInfoSetMessagePayload template)	create builder for OrderShippingInfoSetMessagePayload instance
OrderShippingInfoSetMessagePayload	copyDeep()
static OrderShippingInfoSetMessagePayload	deepCopy(OrderShippingInfoSetMessagePayload template)	factory method to create a deep copy of OrderShippingInfoSetMessagePayload
@Valid ShippingInfo	getOldShippingInfo()	ShippingInfo before the Set Shipping Method or Set Custom Shipping Method update action.
@Valid ShippingInfo	getShippingInfo()	ShippingInfo after the Set Shipping Method or Set Custom Shipping Method update action.
static OrderShippingInfoSetMessagePayload	of()	factory method
static OrderShippingInfoSetMessagePayload	of(OrderShippingInfoSetMessagePayload template)	factory method to create a shallow copy OrderShippingInfoSetMessagePayload
void	setOldShippingInfo(ShippingInfo oldShippingInfo)	ShippingInfo before the Set Shipping Method or Set Custom Shipping Method update action.
void	setShippingInfo(ShippingInfo shippingInfo)	ShippingInfo after the Set Shipping Method or Set Custom Shipping Method update action.
static com.fasterxml.jackson.core.type.TypeReference<OrderShippingInfoSetMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderShippingInfoSetMessagePayload(Function<OrderShippingInfoSetMessagePayload,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_SHIPPING_INFO_SET

static final String ORDER_SHIPPING_INFO_SET

discriminator value for OrderShippingInfoSetMessagePayload

See Also:

• Constant Field Values

Method Details

getShippingInfo

@Valid
@Valid ShippingInfo getShippingInfo()

ShippingInfo after the Set Shipping Method or Set Custom Shipping Method update action.

Returns:

shippingInfo

getOldShippingInfo

@Valid
@Valid ShippingInfo getOldShippingInfo()

ShippingInfo before the Set Shipping Method or Set Custom Shipping Method update action.

Returns:

oldShippingInfo

setShippingInfo

void setShippingInfo(ShippingInfo shippingInfo)

ShippingInfo after the Set Shipping Method or Set Custom Shipping Method update action.

Parameters:

shippingInfo - value to be set

setOldShippingInfo

void setOldShippingInfo(ShippingInfo oldShippingInfo)

ShippingInfo before the Set Shipping Method or Set Custom Shipping Method update action.

Parameters:

oldShippingInfo - value to be set

of

static OrderShippingInfoSetMessagePayload of()

factory method

Returns:

instance of OrderShippingInfoSetMessagePayload

of

static OrderShippingInfoSetMessagePayload of(OrderShippingInfoSetMessagePayload template)

factory method to create a shallow copy OrderShippingInfoSetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderShippingInfoSetMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

Specified by:

copyDeep in interface OrderMessagePayload

deepCopy

@Nullable
static OrderShippingInfoSetMessagePayload deepCopy(@Nullable
 OrderShippingInfoSetMessagePayload template)

factory method to create a deep copy of OrderShippingInfoSetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderShippingInfoSetMessagePayloadBuilder builder()

builder factory method for OrderShippingInfoSetMessagePayload

Returns:

builder

builder

static OrderShippingInfoSetMessagePayloadBuilder builder(OrderShippingInfoSetMessagePayload template)

create builder for OrderShippingInfoSetMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderShippingInfoSetMessagePayload

default <T> T withOrderShippingInfoSetMessagePayload(Function<OrderShippingInfoSetMessagePayload,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<OrderShippingInfoSetMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference