Package com.commercetools.api.models.message

Interface OrderCreatedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface OrderCreatedMessagePayload
extends OrderMessagePayload

Generated after a successful Create Order request, for the initial Order created directly from a Cart.

Orders generated by a Recurring Order schedule do not emit this Message. They emit the OrderCreatedFromRecurringOrder Message instead.

Example to create an instance using the builder pattern

     OrderCreatedMessagePayload orderCreatedMessagePayload = OrderCreatedMessagePayload.builder()
             .order(orderBuilder -> orderBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_CREATED	discriminator value for OrderCreatedMessagePayload

Method Summary

Modifier and Type	Method	Description
static OrderCreatedMessagePayloadBuilder	builder()	builder factory method for OrderCreatedMessagePayload
static OrderCreatedMessagePayloadBuilder	builder(OrderCreatedMessagePayload template)	create builder for OrderCreatedMessagePayload instance
OrderCreatedMessagePayload	copyDeep()
static OrderCreatedMessagePayload	deepCopy(OrderCreatedMessagePayload template)	factory method to create a deep copy of OrderCreatedMessagePayload
@NotNull @Valid Order	getOrder()	Order that was created.
static OrderCreatedMessagePayload	of()	factory method
static OrderCreatedMessagePayload	of(OrderCreatedMessagePayload template)	factory method to create a shallow copy OrderCreatedMessagePayload
void	setOrder(Order order)	Order that was created.
static tools.jackson.core.type.TypeReference<OrderCreatedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderCreatedMessagePayload(Function<OrderCreatedMessagePayload,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_CREATED

static final String ORDER_CREATED

discriminator value for OrderCreatedMessagePayload

See Also:

• Constant Field Values

Method Details

getOrder

@NotNull
@Valid
@NotNull @Valid Order getOrder()

Order that was created.

Returns:

order

setOrder

void setOrder(Order order)

Order that was created.

Parameters:

order - value to be set

of

static OrderCreatedMessagePayload of()

factory method

Returns:

instance of OrderCreatedMessagePayload

of

static OrderCreatedMessagePayload of(OrderCreatedMessagePayload template)

factory method to create a shallow copy OrderCreatedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderCreatedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

Specified by:

copyDeep in interface OrderMessagePayload

deepCopy

@Nullable
static OrderCreatedMessagePayload deepCopy(@Nullable
 OrderCreatedMessagePayload template)

factory method to create a deep copy of OrderCreatedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderCreatedMessagePayloadBuilder builder()

builder factory method for OrderCreatedMessagePayload

Returns:

builder

builder

static OrderCreatedMessagePayloadBuilder builder(OrderCreatedMessagePayload template)

create builder for OrderCreatedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderCreatedMessagePayload

default <T> T withOrderCreatedMessagePayload(Function<OrderCreatedMessagePayload,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<OrderCreatedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference