Package com.commercetools.api.models.message

Interface OrderLineItemDiscountSetMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface OrderLineItemDiscountSetMessagePayload
extends OrderMessagePayload

Generated after a successful recalculation of a Discount on a Line Item.

Example to create an instance using the builder pattern

     OrderLineItemDiscountSetMessagePayload orderLineItemDiscountSetMessagePayload = OrderLineItemDiscountSetMessagePayload.builder()
             .lineItemId("{lineItemId}")
             .plusDiscountedPricePerQuantity(discountedPricePerQuantityBuilder -> discountedPricePerQuantityBuilder)
             .totalPrice(totalPriceBuilder -> totalPriceBuilder)
             .plusTaxedPricePortions(taxedPricePortionsBuilder -> taxedPricePortionsBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_LINE_ITEM_DISCOUNT_SET	discriminator value for OrderLineItemDiscountSetMessagePayload

Method Summary

Modifier and Type	Method	Description
static OrderLineItemDiscountSetMessagePayloadBuilder	builder()	builder factory method for OrderLineItemDiscountSetMessagePayload
static OrderLineItemDiscountSetMessagePayloadBuilder	builder(OrderLineItemDiscountSetMessagePayload template)	create builder for OrderLineItemDiscountSetMessagePayload instance
OrderLineItemDiscountSetMessagePayload	copyDeep()
static OrderLineItemDiscountSetMessagePayload	deepCopy(OrderLineItemDiscountSetMessagePayload template)	factory method to create a deep copy of OrderLineItemDiscountSetMessagePayload
@NotNull @Valid List<DiscountedLineItemPriceForQuantity>	getDiscountedPricePerQuantity()	Array of DiscountedLineItemPriceForQuantity after the Discount recalculation.
@NotNull String	getLineItemId()	Unique identifier for the Line Item.
String	getLineItemKey()	User-defined unique identifier of the LineItem.
@Valid TaxedItemPrice	getTaxedPrice()	TaxedItemPrice of the Line Item after the Discount recalculation.
@NotNull @Valid List<MethodTaxedPrice>	getTaxedPricePortions()	Total taxed prices based on the quantity of Line Item assigned to each Shipping Method.
@NotNull @Valid CentPrecisionMoney	getTotalPrice()	Total Price of the Line Item after the Discount recalculation.
static OrderLineItemDiscountSetMessagePayload	of()	factory method
static OrderLineItemDiscountSetMessagePayload	of(OrderLineItemDiscountSetMessagePayload template)	factory method to create a shallow copy OrderLineItemDiscountSetMessagePayload
void	setDiscountedPricePerQuantity(DiscountedLineItemPriceForQuantity... discountedPricePerQuantity)	Array of DiscountedLineItemPriceForQuantity after the Discount recalculation.
void	setDiscountedPricePerQuantity(List<DiscountedLineItemPriceForQuantity> discountedPricePerQuantity)	Array of DiscountedLineItemPriceForQuantity after the Discount recalculation.
void	setLineItemId(String lineItemId)	Unique identifier for the Line Item.
void	setLineItemKey(String lineItemKey)	User-defined unique identifier of the LineItem.
void	setTaxedPrice(TaxedItemPrice taxedPrice)	TaxedItemPrice of the Line Item after the Discount recalculation.
void	setTaxedPricePortions(MethodTaxedPrice... taxedPricePortions)	Total taxed prices based on the quantity of Line Item assigned to each Shipping Method.
void	setTaxedPricePortions(List<MethodTaxedPrice> taxedPricePortions)	Total taxed prices based on the quantity of Line Item assigned to each Shipping Method.
void	setTotalPrice(CentPrecisionMoney totalPrice)	Total Price of the Line Item after the Discount recalculation.
static com.fasterxml.jackson.core.type.TypeReference<OrderLineItemDiscountSetMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderLineItemDiscountSetMessagePayload(Function<OrderLineItemDiscountSetMessagePayload,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_DISCOUNT_SET

static final String ORDER_LINE_ITEM_DISCOUNT_SET

discriminator value for OrderLineItemDiscountSetMessagePayload

See Also:

• Constant Field Values

Method Details

getLineItemId

@NotNull
@NotNull String getLineItemId()

Unique identifier for the Line Item.

Returns:

lineItemId

getLineItemKey

String getLineItemKey()

User-defined unique identifier of the LineItem.

Returns:

lineItemKey

getDiscountedPricePerQuantity

@NotNull
@Valid
@NotNull @Valid List<DiscountedLineItemPriceForQuantity> getDiscountedPricePerQuantity()

Array of DiscountedLineItemPriceForQuantity after the Discount recalculation.

Returns:

discountedPricePerQuantity

getTotalPrice

@NotNull
@Valid
@NotNull @Valid CentPrecisionMoney getTotalPrice()

Total Price of the Line Item after the Discount recalculation.

Returns:

totalPrice

getTaxedPrice

@Valid
@Valid TaxedItemPrice getTaxedPrice()

TaxedItemPrice of the Line Item after the Discount recalculation.

Returns:

taxedPrice

getTaxedPricePortions

@NotNull
@Valid
@NotNull @Valid List<MethodTaxedPrice> getTaxedPricePortions()

Total taxed prices based on the quantity of Line Item assigned to each Shipping Method. Only applicable for Carts with Multiple ShippingMode. Automatically set after perMethodTaxRate is set.

Returns:

taxedPricePortions

setLineItemId

void setLineItemId(String lineItemId)

Unique identifier for 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

setDiscountedPricePerQuantity

void setDiscountedPricePerQuantity(DiscountedLineItemPriceForQuantity... discountedPricePerQuantity)

Array of DiscountedLineItemPriceForQuantity after the Discount recalculation.

Parameters:

discountedPricePerQuantity - values to be set

setDiscountedPricePerQuantity

void setDiscountedPricePerQuantity(List<DiscountedLineItemPriceForQuantity> discountedPricePerQuantity)

Array of DiscountedLineItemPriceForQuantity after the Discount recalculation.

Parameters:

discountedPricePerQuantity - values to be set

setTotalPrice

void setTotalPrice(CentPrecisionMoney totalPrice)

Total Price of the Line Item after the Discount recalculation.

Parameters:

totalPrice - value to be set

setTaxedPrice

void setTaxedPrice(TaxedItemPrice taxedPrice)

TaxedItemPrice of the Line Item after the Discount recalculation.

Parameters:

taxedPrice - value to be set

setTaxedPricePortions

void setTaxedPricePortions(MethodTaxedPrice... taxedPricePortions)

Total taxed prices based on the quantity of Line Item assigned to each Shipping Method. Only applicable for Carts with Multiple ShippingMode. Automatically set after perMethodTaxRate is set.

Parameters:

taxedPricePortions - values to be set

setTaxedPricePortions

void setTaxedPricePortions(List<MethodTaxedPrice> taxedPricePortions)

Total taxed prices based on the quantity of Line Item assigned to each Shipping Method. Only applicable for Carts with Multiple ShippingMode. Automatically set after perMethodTaxRate is set.

Parameters:

taxedPricePortions - values to be set

of

static OrderLineItemDiscountSetMessagePayload of()

factory method

Returns:

instance of OrderLineItemDiscountSetMessagePayload

of

static OrderLineItemDiscountSetMessagePayload of(OrderLineItemDiscountSetMessagePayload template)

factory method to create a shallow copy OrderLineItemDiscountSetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderLineItemDiscountSetMessagePayload copyDeep()

Specified by:

copyDeep in interface MessagePayload

Specified by:

copyDeep in interface OrderMessagePayload

deepCopy

@Nullable
static OrderLineItemDiscountSetMessagePayload deepCopy(@Nullable
 OrderLineItemDiscountSetMessagePayload template)

factory method to create a deep copy of OrderLineItemDiscountSetMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderLineItemDiscountSetMessagePayloadBuilder builder()

builder factory method for OrderLineItemDiscountSetMessagePayload

Returns:

builder

builder

static OrderLineItemDiscountSetMessagePayloadBuilder builder(OrderLineItemDiscountSetMessagePayload template)

create builder for OrderLineItemDiscountSetMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderLineItemDiscountSetMessagePayload

default <T> T withOrderLineItemDiscountSetMessagePayload(Function<OrderLineItemDiscountSetMessagePayload,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<OrderLineItemDiscountSetMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference