Package com.commercetools.api.models.event

Interface CheckoutOrderCreationFailedEvent

All Superinterfaces:

Event

public interface CheckoutOrderCreationFailedEvent
extends Event

Generated when an order creation attempt fails in Checkout. This event includes information about why the order could not be created.

Example to create an instance using the builder pattern

     CheckoutOrderCreationFailedEvent checkoutOrderCreationFailedEvent = CheckoutOrderCreationFailedEvent.builder()
             .id("{id}")
             .notificationType("{notificationType}")
             .resourceType(EventSubscriptionResourceTypeId.CHECKOUT)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .data(dataBuilder -> dataBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHECKOUT_ORDER_CREATION_FAILED	discriminator value for CheckoutOrderCreationFailedEvent

Method Summary

Modifier and Type	Method	Description
static CheckoutOrderCreationFailedEventBuilder	builder()	builder factory method for CheckoutOrderCreationFailedEvent
static CheckoutOrderCreationFailedEventBuilder	builder(CheckoutOrderCreationFailedEvent template)	create builder for CheckoutOrderCreationFailedEvent instance
CheckoutOrderCreationFailedEvent	copyDeep()
static CheckoutOrderCreationFailedEvent	deepCopy(CheckoutOrderCreationFailedEvent template)	factory method to create a deep copy of CheckoutOrderCreationFailedEvent
@NotNull @Valid CheckoutMessageOrderPayloadBaseData	getData()	An object containing details of the order which could not be created.
@NotNull EventSubscriptionResourceTypeId	getResourceType()	The type of resource targeted by the Event.
static CheckoutOrderCreationFailedEvent	of()	factory method
static CheckoutOrderCreationFailedEvent	of(CheckoutOrderCreationFailedEvent template)	factory method to create a shallow copy CheckoutOrderCreationFailedEvent
void	setData(CheckoutMessageOrderPayloadBaseData data)	An object containing details of the order which could not be created.
void	setResourceType(EventSubscriptionResourceTypeId resourceType)	set resourceType
static com.fasterxml.jackson.core.type.TypeReference<CheckoutOrderCreationFailedEvent>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCheckoutOrderCreationFailedEvent(Function<CheckoutOrderCreationFailedEvent,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.event.Event

getCreatedAt, getId, getNotificationType, getType, setCreatedAt, setId, setNotificationType, withEvent

Field Details

CHECKOUT_ORDER_CREATION_FAILED

static final String CHECKOUT_ORDER_CREATION_FAILED

discriminator value for CheckoutOrderCreationFailedEvent

See Also:

• Constant Field Values

Method Details

getResourceType

@NotNull
@NotNull EventSubscriptionResourceTypeId getResourceType()

Description copied from interface: Event

The type of resource targeted by the Event.

Specified by:

getResourceType in interface Event

Returns:

resourceType

getData

@NotNull
@Valid
@NotNull @Valid CheckoutMessageOrderPayloadBaseData getData()

An object containing details of the order which could not be created.

Returns:

data

setResourceType

void setResourceType(EventSubscriptionResourceTypeId resourceType)

set resourceType

Specified by:

setResourceType in interface Event

Parameters:

resourceType - value to be set

setData

void setData(CheckoutMessageOrderPayloadBaseData data)

An object containing details of the order which could not be created.

Parameters:

data - value to be set

of

static CheckoutOrderCreationFailedEvent of()

factory method

Returns:

instance of CheckoutOrderCreationFailedEvent

of

static CheckoutOrderCreationFailedEvent of(CheckoutOrderCreationFailedEvent template)

factory method to create a shallow copy CheckoutOrderCreationFailedEvent

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CheckoutOrderCreationFailedEvent copyDeep()

Specified by:

copyDeep in interface Event

deepCopy

@Nullable
static CheckoutOrderCreationFailedEvent deepCopy(@Nullable
 CheckoutOrderCreationFailedEvent template)

factory method to create a deep copy of CheckoutOrderCreationFailedEvent

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CheckoutOrderCreationFailedEventBuilder builder()

builder factory method for CheckoutOrderCreationFailedEvent

Returns:

builder

builder

static CheckoutOrderCreationFailedEventBuilder builder(CheckoutOrderCreationFailedEvent template)

create builder for CheckoutOrderCreationFailedEvent instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCheckoutOrderCreationFailedEvent

default <T> T withCheckoutOrderCreationFailedEvent(Function<CheckoutOrderCreationFailedEvent,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<CheckoutOrderCreationFailedEvent> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference