Package com.commercetools.api.models.message

Interface OrderLineItemDiscountSetMessage

All Superinterfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, OrderMessage, Versioned<Message>

public interface OrderLineItemDiscountSetMessage
extends OrderMessage

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

Example to create an instance using the builder pattern

     OrderLineItemDiscountSetMessage orderLineItemDiscountSetMessage = OrderLineItemDiscountSetMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .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 OrderLineItemDiscountSetMessage

Method Summary

Modifier and Type	Method	Description
static OrderLineItemDiscountSetMessageBuilder	builder()	builder factory method for OrderLineItemDiscountSetMessage
static OrderLineItemDiscountSetMessageBuilder	builder(OrderLineItemDiscountSetMessage template)	create builder for OrderLineItemDiscountSetMessage instance
OrderLineItemDiscountSetMessage	copyDeep()
static OrderLineItemDiscountSetMessage	deepCopy(OrderLineItemDiscountSetMessage template)	factory method to create a deep copy of OrderLineItemDiscountSetMessage
@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 OrderLineItemDiscountSetMessage	of()	factory method
static OrderLineItemDiscountSetMessage	of(OrderLineItemDiscountSetMessage template)	factory method to create a shallow copy OrderLineItemDiscountSetMessage
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<OrderLineItemDiscountSetMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderLineItemDiscountSetMessage(Function<OrderLineItemDiscountSetMessage,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

Methods inherited from interface com.commercetools.api.models.DomainResource

get

Methods inherited from interface com.commercetools.api.models.message.Message

getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage

Methods inherited from interface com.commercetools.api.models.message.OrderMessage

withOrderMessage

Field Details

ORDER_LINE_ITEM_DISCOUNT_SET

static final String ORDER_LINE_ITEM_DISCOUNT_SET

discriminator value for OrderLineItemDiscountSetMessage

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 OrderLineItemDiscountSetMessage of()

factory method

Returns:

instance of OrderLineItemDiscountSetMessage

of

static OrderLineItemDiscountSetMessage of(OrderLineItemDiscountSetMessage template)

factory method to create a shallow copy OrderLineItemDiscountSetMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderLineItemDiscountSetMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

Specified by:

copyDeep in interface OrderMessage

deepCopy

@Nullable
static OrderLineItemDiscountSetMessage deepCopy(@Nullable
 OrderLineItemDiscountSetMessage template)

factory method to create a deep copy of OrderLineItemDiscountSetMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderLineItemDiscountSetMessageBuilder builder()

builder factory method for OrderLineItemDiscountSetMessage

Returns:

builder

builder

static OrderLineItemDiscountSetMessageBuilder builder(OrderLineItemDiscountSetMessage template)

create builder for OrderLineItemDiscountSetMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderLineItemDiscountSetMessage

default <T> T withOrderLineItemDiscountSetMessage(Function<OrderLineItemDiscountSetMessage,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<OrderLineItemDiscountSetMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference