Package com.commercetools.api.models.message

Interface OrderCustomLineItemRemovedMessagePayload

All Superinterfaces:

MessagePayload, OrderMessagePayload

All Known Implementing Classes:

OrderCustomLineItemRemovedMessagePayloadImpl

public interface OrderCustomLineItemRemovedMessagePayload
extends OrderMessagePayload

Generated after a successful Remove CustomLineItem update action.

Example to create an instance using the builder pattern

     OrderCustomLineItemRemovedMessagePayload orderCustomLineItemRemovedMessagePayload = OrderCustomLineItemRemovedMessagePayload.builder()
             .customLineItemId("{customLineItemId}")
             .customLineItem(customLineItemBuilder -> customLineItemBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_CUSTOM_LINE_ITEM_REMOVED	discriminator value for OrderCustomLineItemRemovedMessagePayload

Method Summary

Modifier and Type	Method	Description
static OrderCustomLineItemRemovedMessagePayloadBuilder	builder()	builder factory method for OrderCustomLineItemRemovedMessagePayload
static OrderCustomLineItemRemovedMessagePayloadBuilder	builder(OrderCustomLineItemRemovedMessagePayload template)	create builder for OrderCustomLineItemRemovedMessagePayload instance
static OrderCustomLineItemRemovedMessagePayload	deepCopy(OrderCustomLineItemRemovedMessagePayload template)	factory method to create a deep copy of OrderCustomLineItemRemovedMessagePayload
@NotNull @Valid CustomLineItem	getCustomLineItem()	Custom Line Item that was removed from the Order.
@NotNull String	getCustomLineItemId()	Unique identifier of the Custom Line Item.
String	getCustomLineItemKey()	User-defined unique identifier of the Custom Line Item.
static OrderCustomLineItemRemovedMessagePayload	of()	factory method
static OrderCustomLineItemRemovedMessagePayload	of(OrderCustomLineItemRemovedMessagePayload template)	factory method to create a shallow copy OrderCustomLineItemRemovedMessagePayload
void	setCustomLineItem(CustomLineItem customLineItem)	Custom Line Item that was removed from the Order.
void	setCustomLineItemId(String customLineItemId)	Unique identifier of the Custom Line Item.
void	setCustomLineItemKey(String customLineItemKey)	User-defined unique identifier of the Custom Line Item.
static com.fasterxml.jackson.core.type.TypeReference<OrderCustomLineItemRemovedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderCustomLineItemRemovedMessagePayload(Function<OrderCustomLineItemRemovedMessagePayload,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.OrderMessagePayload

withOrderMessagePayload

Field Details

ORDER_CUSTOM_LINE_ITEM_REMOVED

static final String ORDER_CUSTOM_LINE_ITEM_REMOVED

discriminator value for OrderCustomLineItemRemovedMessagePayload

See Also:

• Constant Field Values

Method Details

getCustomLineItemId

@NotNull
@NotNull String getCustomLineItemId()

Unique identifier of the Custom Line Item.

Returns:

customLineItemId

getCustomLineItemKey

String getCustomLineItemKey()

User-defined unique identifier of the Custom Line Item.

Returns:

customLineItemKey

getCustomLineItem

@NotNull
@Valid
@NotNull @Valid CustomLineItem getCustomLineItem()

Custom Line Item that was removed from the Order.

Returns:

customLineItem

setCustomLineItemId

void setCustomLineItemId(String customLineItemId)

Unique identifier of the Custom Line Item.

Parameters:

customLineItemId - value to be set

setCustomLineItemKey

void setCustomLineItemKey(String customLineItemKey)

User-defined unique identifier of the Custom Line Item.

Parameters:

customLineItemKey - value to be set

setCustomLineItem

void setCustomLineItem(CustomLineItem customLineItem)

Custom Line Item that was removed from the Order.

Parameters:

customLineItem - value to be set

of

static OrderCustomLineItemRemovedMessagePayload of()

factory method

Returns:

instance of OrderCustomLineItemRemovedMessagePayload

of

static OrderCustomLineItemRemovedMessagePayload of(OrderCustomLineItemRemovedMessagePayload template)

factory method to create a shallow copy OrderCustomLineItemRemovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderCustomLineItemRemovedMessagePayload deepCopy(@Nullable
 OrderCustomLineItemRemovedMessagePayload template)

factory method to create a deep copy of OrderCustomLineItemRemovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderCustomLineItemRemovedMessagePayloadBuilder builder()

builder factory method for OrderCustomLineItemRemovedMessagePayload

Returns:

builder

builder

static OrderCustomLineItemRemovedMessagePayloadBuilder builder(OrderCustomLineItemRemovedMessagePayload template)

create builder for OrderCustomLineItemRemovedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderCustomLineItemRemovedMessagePayload

default <T> T withOrderCustomLineItemRemovedMessagePayload(Function<OrderCustomLineItemRemovedMessagePayload,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<OrderCustomLineItemRemovedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference