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 Details

    • ORDER_LINE_ITEM_DISCOUNT_SET

      static final String ORDER_LINE_ITEM_DISCOUNT_SET
      discriminator value for OrderLineItemDiscountSetMessagePayload
      See Also:

  • 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 Money 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(Money 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

    • 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