Package com.commercetools.api.models.message

Interface OrderShippingAddressSetMessage

All Superinterfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, OrderMessage, Versioned<Message>

public interface OrderShippingAddressSetMessage
extends OrderMessage

Generated after a successful Set Shipping Address update action.

Example to create an instance using the builder pattern

     OrderShippingAddressSetMessage orderShippingAddressSetMessage = OrderShippingAddressSetMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static OrderShippingAddressSetMessageBuilder	builder()	builder factory method for OrderShippingAddressSetMessage
static OrderShippingAddressSetMessageBuilder	builder(OrderShippingAddressSetMessage template)	create builder for OrderShippingAddressSetMessage instance
OrderShippingAddressSetMessage	copyDeep()
static OrderShippingAddressSetMessage	deepCopy(OrderShippingAddressSetMessage template)	factory method to create a deep copy of OrderShippingAddressSetMessage
@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 OrderShippingAddressSetMessage	of()	factory method
static OrderShippingAddressSetMessage	of(OrderShippingAddressSetMessage template)	factory method to create a shallow copy OrderShippingAddressSetMessage
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<OrderShippingAddressSetMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderShippingAddressSetMessage(Function<OrderShippingAddressSetMessage,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

Methods inherited from interface com.commercetools.api.models.DomainResource

get

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

getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage

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

withOrderMessage

Field Details

ORDER_SHIPPING_ADDRESS_SET

static final String ORDER_SHIPPING_ADDRESS_SET

discriminator value for OrderShippingAddressSetMessage

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 OrderShippingAddressSetMessage of()

factory method

Returns:

instance of OrderShippingAddressSetMessage

of

static OrderShippingAddressSetMessage of(OrderShippingAddressSetMessage template)

factory method to create a shallow copy OrderShippingAddressSetMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderShippingAddressSetMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

Specified by:

copyDeep in interface OrderMessage

deepCopy

@Nullable
static OrderShippingAddressSetMessage deepCopy(@Nullable
 OrderShippingAddressSetMessage template)

factory method to create a deep copy of OrderShippingAddressSetMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderShippingAddressSetMessageBuilder builder()

builder factory method for OrderShippingAddressSetMessage

Returns:

builder

builder

static OrderShippingAddressSetMessageBuilder builder(OrderShippingAddressSetMessage template)

create builder for OrderShippingAddressSetMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderShippingAddressSetMessage

default <T> T withOrderShippingAddressSetMessage(Function<OrderShippingAddressSetMessage,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<OrderShippingAddressSetMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference