Package com.commercetools.api.models.message

Interface OrderShippingAddressSetMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface OrderShippingAddressSetMessagePayload
extends OrderMessagePayload

Generated after a successful Set Shipping Address update action.

Example to create an instance using the builder pattern

     OrderShippingAddressSetMessagePayload orderShippingAddressSetMessagePayload = OrderShippingAddressSetMessagePayload.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_SHIPPING_ADDRESS_SET	discriminator value for OrderShippingAddressSetMessagePayload

Method Summary

Modifier and Type	Method	Description
static OrderShippingAddressSetMessagePayloadBuilder	builder()	builder factory method for OrderShippingAddressSetMessagePayload
static OrderShippingAddressSetMessagePayloadBuilder	builder(OrderShippingAddressSetMessagePayload template)	create builder for OrderShippingAddressSetMessagePayload instance
OrderShippingAddressSetMessagePayload	copyDeep()
static OrderShippingAddressSetMessagePayload	deepCopy(OrderShippingAddressSetMessagePayload template)	factory method to create a deep copy of OrderShippingAddressSetMessagePayload
@Valid Address	getAddress()	Shipping address on the Order after the Set Shipping Address update action.
@Valid Address	getOldAddress()	Shipping address on the Order before the Set Shipping Address update action.
static OrderShippingAddressSetMessagePayload	of()	factory method
static OrderShippingAddressSetMessagePayload	of(OrderShippingAddressSetMessagePayload template)	factory method to create a shallow copy OrderShippingAddressSetMessagePayload
void	setAddress(Address address)	Shipping address on the Order after the Set Shipping Address update action.
void	setOldAddress(Address oldAddress)	Shipping address on the Order before the Set Shipping Address update action.
static com.fasterxml.jackson.core.type.TypeReference<OrderShippingAddressSetMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderShippingAddressSetMessagePayload(Function<OrderShippingAddressSetMessagePayload,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_ADDRESS_SET

static final String ORDER_SHIPPING_ADDRESS_SET

discriminator value for OrderShippingAddressSetMessagePayload

See Also:

• Constant Field Values

Method Details

getAddress

@Valid
@Valid Address getAddress()

Shipping address on the Order after the Set Shipping Address update action.

Returns:

address

getOldAddress

@Valid
@Valid Address getOldAddress()

Shipping address on the Order before the Set Shipping Address update action.

Returns:

oldAddress

setAddress

void setAddress(Address address)

Shipping address on the Order after the Set Shipping Address update action.

Parameters:

address - value to be set

setOldAddress

void setOldAddress(Address oldAddress)

Shipping address on the Order before the Set Shipping Address update action.

Parameters:

oldAddress - value to be set

of

static OrderShippingAddressSetMessagePayload of()

factory method

Returns:

instance of OrderShippingAddressSetMessagePayload

of

static OrderShippingAddressSetMessagePayload of(OrderShippingAddressSetMessagePayload template)

factory method to create a shallow copy OrderShippingAddressSetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderShippingAddressSetMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

Specified by:

copyDeep in interface OrderMessagePayload

deepCopy

@Nullable
static OrderShippingAddressSetMessagePayload deepCopy(@Nullable
 OrderShippingAddressSetMessagePayload template)

factory method to create a deep copy of OrderShippingAddressSetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderShippingAddressSetMessagePayloadBuilder builder()

builder factory method for OrderShippingAddressSetMessagePayload

Returns:

builder

builder

static OrderShippingAddressSetMessagePayloadBuilder builder(OrderShippingAddressSetMessagePayload template)

create builder for OrderShippingAddressSetMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderShippingAddressSetMessagePayload

default <T> T withOrderShippingAddressSetMessagePayload(Function<OrderShippingAddressSetMessagePayload,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<OrderShippingAddressSetMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference