Package com.commercetools.api.models.message

Interface OrderLineItemRemovedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface OrderLineItemRemovedMessagePayload
extends OrderMessagePayload

Generated after a successful Remove LineItem update action.

Example to create an instance using the builder pattern

     OrderLineItemRemovedMessagePayload orderLineItemRemovedMessagePayload = OrderLineItemRemovedMessagePayload.builder()
             .lineItemId("{lineItemId}")
             .removedQuantity(0.3)
             .newQuantity(0.3)
             .plusNewState(newStateBuilder -> newStateBuilder)
             .newTotalPrice(newTotalPriceBuilder -> newTotalPriceBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_LINE_ITEM_REMOVED	discriminator value for OrderLineItemRemovedMessagePayload

Method Summary

Modifier and Type	Method	Description
static OrderLineItemRemovedMessagePayloadBuilder	builder()	builder factory method for OrderLineItemRemovedMessagePayload
static OrderLineItemRemovedMessagePayloadBuilder	builder(OrderLineItemRemovedMessagePayload template)	create builder for OrderLineItemRemovedMessagePayload instance
OrderLineItemRemovedMessagePayload	copyDeep()
static OrderLineItemRemovedMessagePayload	deepCopy(OrderLineItemRemovedMessagePayload template)	factory method to create a deep copy of OrderLineItemRemovedMessagePayload
@NotNull String	getLineItemId()	Unique identifier of the Line Item.
String	getLineItemKey()	User-defined unique identifier of the LineItem.
@Valid Price	getNewPrice()	Price of the Order after the Remove LineItem update action.
@NotNull Long	getNewQuantity()	Line Item quantity after the Remove LineItem update action.
@Valid ItemShippingDetails	getNewShippingDetail()	Shipping Details of the Order after the Remove LineItem update action.
@NotNull @Valid List<ItemState>	getNewState()	ItemStates after the Remove LineItem update action.
@Valid TaxedItemPrice	getNewTaxedPrice()	TaxedItemPrice of the Order after the Remove LineItem update action.
@NotNull @Valid CentPrecisionMoney	getNewTotalPrice()	totalPrice of the Order after the Remove LineItem update action.
@NotNull Long	getRemovedQuantity()	Quantity of Line Items that were removed during the Remove LineItem update action.
static OrderLineItemRemovedMessagePayload	of()	factory method
static OrderLineItemRemovedMessagePayload	of(OrderLineItemRemovedMessagePayload template)	factory method to create a shallow copy OrderLineItemRemovedMessagePayload
void	setLineItemId(String lineItemId)	Unique identifier of the Line Item.
void	setLineItemKey(String lineItemKey)	User-defined unique identifier of the LineItem.
void	setNewPrice(Price newPrice)	Price of the Order after the Remove LineItem update action.
void	setNewQuantity(Long newQuantity)	Line Item quantity after the Remove LineItem update action.
void	setNewShippingDetail(ItemShippingDetails newShippingDetail)	Shipping Details of the Order after the Remove LineItem update action.
void	setNewState(ItemState... newState)	ItemStates after the Remove LineItem update action.
void	setNewState(List<ItemState> newState)	ItemStates after the Remove LineItem update action.
void	setNewTaxedPrice(TaxedItemPrice newTaxedPrice)	TaxedItemPrice of the Order after the Remove LineItem update action.
void	setNewTotalPrice(CentPrecisionMoney newTotalPrice)	totalPrice of the Order after the Remove LineItem update action.
void	setRemovedQuantity(Long removedQuantity)	Quantity of Line Items that were removed during the Remove LineItem update action.
static com.fasterxml.jackson.core.type.TypeReference<OrderLineItemRemovedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderLineItemRemovedMessagePayload(Function<OrderLineItemRemovedMessagePayload,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_LINE_ITEM_REMOVED

static final String ORDER_LINE_ITEM_REMOVED

discriminator value for OrderLineItemRemovedMessagePayload

See Also:

• Constant Field Values

Method Details

getLineItemId

@NotNull
@NotNull String getLineItemId()

Unique identifier of the Line Item.

Returns:

lineItemId

getLineItemKey

String getLineItemKey()

User-defined unique identifier of the LineItem.

Returns:

lineItemKey

getRemovedQuantity

@NotNull
@NotNull Long getRemovedQuantity()

Quantity of Line Items that were removed during the Remove LineItem update action.

Returns:

removedQuantity

getNewQuantity

@NotNull
@NotNull Long getNewQuantity()

Line Item quantity after the Remove LineItem update action.

Returns:

newQuantity

getNewState

@NotNull
@Valid
@NotNull @Valid List<ItemState> getNewState()

ItemStates after the Remove LineItem update action.

Returns:

newState

getNewTotalPrice

@NotNull
@Valid
@NotNull @Valid CentPrecisionMoney getNewTotalPrice()

totalPrice of the Order after the Remove LineItem update action.

Returns:

newTotalPrice

getNewTaxedPrice

@Valid
@Valid TaxedItemPrice getNewTaxedPrice()

TaxedItemPrice of the Order after the Remove LineItem update action.

Returns:

newTaxedPrice

getNewPrice

@Valid
@Valid Price getNewPrice()

Price of the Order after the Remove LineItem update action.

Returns:

newPrice

getNewShippingDetail

@Valid
@Valid ItemShippingDetails getNewShippingDetail()

Shipping Details of the Order after the Remove LineItem update action.

Returns:

newShippingDetail

setLineItemId

void setLineItemId(String lineItemId)

Unique identifier of the Line Item.

Parameters:

lineItemId - value to be set

setLineItemKey

void setLineItemKey(String lineItemKey)

User-defined unique identifier of the LineItem.

Parameters:

lineItemKey - value to be set

setRemovedQuantity

void setRemovedQuantity(Long removedQuantity)

Quantity of Line Items that were removed during the Remove LineItem update action.

Parameters:

removedQuantity - value to be set

setNewQuantity

void setNewQuantity(Long newQuantity)

Line Item quantity after the Remove LineItem update action.

Parameters:

newQuantity - value to be set

setNewState

void setNewState(ItemState... newState)

ItemStates after the Remove LineItem update action.

Parameters:

newState - values to be set

setNewState

void setNewState(List<ItemState> newState)

ItemStates after the Remove LineItem update action.

Parameters:

newState - values to be set

setNewTotalPrice

void setNewTotalPrice(CentPrecisionMoney newTotalPrice)

totalPrice of the Order after the Remove LineItem update action.

Parameters:

newTotalPrice - value to be set

setNewTaxedPrice

void setNewTaxedPrice(TaxedItemPrice newTaxedPrice)

TaxedItemPrice of the Order after the Remove LineItem update action.

Parameters:

newTaxedPrice - value to be set

setNewPrice

void setNewPrice(Price newPrice)

Price of the Order after the Remove LineItem update action.

Parameters:

newPrice - value to be set

setNewShippingDetail

void setNewShippingDetail(ItemShippingDetails newShippingDetail)

Shipping Details of the Order after the Remove LineItem update action.

Parameters:

newShippingDetail - value to be set

of

static OrderLineItemRemovedMessagePayload of()

factory method

Returns:

instance of OrderLineItemRemovedMessagePayload

of

static OrderLineItemRemovedMessagePayload of(OrderLineItemRemovedMessagePayload template)

factory method to create a shallow copy OrderLineItemRemovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderLineItemRemovedMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

Specified by:

copyDeep in interface OrderMessagePayload

deepCopy

@Nullable
static OrderLineItemRemovedMessagePayload deepCopy(@Nullable
 OrderLineItemRemovedMessagePayload template)

factory method to create a deep copy of OrderLineItemRemovedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderLineItemRemovedMessagePayloadBuilder builder()

builder factory method for OrderLineItemRemovedMessagePayload

Returns:

builder

builder

static OrderLineItemRemovedMessagePayloadBuilder builder(OrderLineItemRemovedMessagePayload template)

create builder for OrderLineItemRemovedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderLineItemRemovedMessagePayload

default <T> T withOrderLineItemRemovedMessagePayload(Function<OrderLineItemRemovedMessagePayload,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<OrderLineItemRemovedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference