Package com.commercetools.api.models.message

Interface OrderCreatedFromRecurringOrderMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface OrderCreatedFromRecurringOrderMessagePayload
extends OrderMessagePayload

Generated after an Order is successfully created according to the defined schedule of a Recurring Order.

Example to create an instance using the builder pattern

     OrderCreatedFromRecurringOrderMessagePayload orderCreatedFromRecurringOrderMessagePayload = OrderCreatedFromRecurringOrderMessagePayload.builder()
             .order(orderBuilder -> orderBuilder)
             .recurringOrderRef(recurringOrderRefBuilder -> recurringOrderRefBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_CREATED_FROM_RECURRING_ORDER	discriminator value for OrderCreatedFromRecurringOrderMessagePayload

Method Summary

Modifier and Type	Method	Description
static OrderCreatedFromRecurringOrderMessagePayloadBuilder	builder()	builder factory method for OrderCreatedFromRecurringOrderMessagePayload
static OrderCreatedFromRecurringOrderMessagePayloadBuilder	builder(OrderCreatedFromRecurringOrderMessagePayload template)	create builder for OrderCreatedFromRecurringOrderMessagePayload instance
OrderCreatedFromRecurringOrderMessagePayload	copyDeep()
static OrderCreatedFromRecurringOrderMessagePayload	deepCopy(OrderCreatedFromRecurringOrderMessagePayload template)	factory method to create a deep copy of OrderCreatedFromRecurringOrderMessagePayload
@NotNull @Valid Order	getOrder()	Order that was created.
@NotNull @Valid RecurringOrderReference	getRecurringOrderRef()	Reference to the origin Recurring Order.
static OrderCreatedFromRecurringOrderMessagePayload	of()	factory method
static OrderCreatedFromRecurringOrderMessagePayload	of(OrderCreatedFromRecurringOrderMessagePayload template)	factory method to create a shallow copy OrderCreatedFromRecurringOrderMessagePayload
void	setOrder(Order order)	Order that was created.
void	setRecurringOrderRef(RecurringOrderReference recurringOrderRef)	Reference to the origin Recurring Order.
static com.fasterxml.jackson.core.type.TypeReference<OrderCreatedFromRecurringOrderMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderCreatedFromRecurringOrderMessagePayload(Function<OrderCreatedFromRecurringOrderMessagePayload,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_FROM_RECURRING_ORDER

static final String ORDER_CREATED_FROM_RECURRING_ORDER

discriminator value for OrderCreatedFromRecurringOrderMessagePayload

See Also:

• Constant Field Values

Method Details

getOrder

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

Order that was created.

Returns:

order

getRecurringOrderRef

@NotNull
@Valid
@NotNull @Valid RecurringOrderReference getRecurringOrderRef()

Reference to the origin Recurring Order.

Returns:

recurringOrderRef

setOrder

void setOrder(Order order)

Order that was created.

Parameters:

order - value to be set

setRecurringOrderRef

void setRecurringOrderRef(RecurringOrderReference recurringOrderRef)

Reference to the origin Recurring Order.

Parameters:

recurringOrderRef - value to be set

of

static OrderCreatedFromRecurringOrderMessagePayload of()

factory method

Returns:

instance of OrderCreatedFromRecurringOrderMessagePayload

of

static OrderCreatedFromRecurringOrderMessagePayload of(OrderCreatedFromRecurringOrderMessagePayload template)

factory method to create a shallow copy OrderCreatedFromRecurringOrderMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderCreatedFromRecurringOrderMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

Specified by:

copyDeep in interface OrderMessagePayload

deepCopy

@Nullable
static OrderCreatedFromRecurringOrderMessagePayload deepCopy(@Nullable
 OrderCreatedFromRecurringOrderMessagePayload template)

factory method to create a deep copy of OrderCreatedFromRecurringOrderMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderCreatedFromRecurringOrderMessagePayloadBuilder builder()

builder factory method for OrderCreatedFromRecurringOrderMessagePayload

Returns:

builder

builder

static OrderCreatedFromRecurringOrderMessagePayloadBuilder builder(OrderCreatedFromRecurringOrderMessagePayload template)

create builder for OrderCreatedFromRecurringOrderMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderCreatedFromRecurringOrderMessagePayload

default <T> T withOrderCreatedFromRecurringOrderMessagePayload(Function<OrderCreatedFromRecurringOrderMessagePayload,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<OrderCreatedFromRecurringOrderMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference