Package com.commercetools.api.models.message

Interface OrderShippingInfoSetMessage

All Superinterfaces:

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

public interface OrderShippingInfoSetMessage
extends OrderMessage

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

Example to create an instance using the builder pattern

     OrderShippingInfoSetMessage orderShippingInfoSetMessage = OrderShippingInfoSetMessage.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_INFO_SET	discriminator value for OrderShippingInfoSetMessage

Method Summary

Modifier and Type	Method	Description
static OrderShippingInfoSetMessageBuilder	builder()	builder factory method for OrderShippingInfoSetMessage
static OrderShippingInfoSetMessageBuilder	builder(OrderShippingInfoSetMessage template)	create builder for OrderShippingInfoSetMessage instance
OrderShippingInfoSetMessage	copyDeep()
static OrderShippingInfoSetMessage	deepCopy(OrderShippingInfoSetMessage template)	factory method to create a deep copy of OrderShippingInfoSetMessage
@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 OrderShippingInfoSetMessage	of()	factory method
static OrderShippingInfoSetMessage	of(OrderShippingInfoSetMessage template)	factory method to create a shallow copy OrderShippingInfoSetMessage
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<OrderShippingInfoSetMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderShippingInfoSetMessage(Function<OrderShippingInfoSetMessage,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_INFO_SET

static final String ORDER_SHIPPING_INFO_SET

discriminator value for OrderShippingInfoSetMessage

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

factory method

Returns:

instance of OrderShippingInfoSetMessage

of

static OrderShippingInfoSetMessage of(OrderShippingInfoSetMessage template)

factory method to create a shallow copy OrderShippingInfoSetMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderShippingInfoSetMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

Specified by:

copyDeep in interface OrderMessage

deepCopy

@Nullable
static OrderShippingInfoSetMessage deepCopy(@Nullable
 OrderShippingInfoSetMessage template)

factory method to create a deep copy of OrderShippingInfoSetMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderShippingInfoSetMessageBuilder builder()

builder factory method for OrderShippingInfoSetMessage

Returns:

builder

builder

static OrderShippingInfoSetMessageBuilder builder(OrderShippingInfoSetMessage template)

create builder for OrderShippingInfoSetMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderShippingInfoSetMessage

default <T> T withOrderShippingInfoSetMessage(Function<OrderShippingInfoSetMessage,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<OrderShippingInfoSetMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference