Package com.commercetools.api.models.common

Interface DiscountedPrice

public interface DiscountedPrice
DiscountedPrice
Example to create an instance using the builder pattern 

     DiscountedPrice discountedPrice = DiscountedPrice.builder()
             .value(valueBuilder -> valueBuilder)
             .discount(discountBuilder -> discountBuilder)
             .build()

  • Method Details

    • getValue

      @NotNull @Valid @NotNull @Valid TypedMoney getValue()

      Money value of the discounted price.

      • When a relative Product Discount applies and the fractional part of the resulting discounted price is 0.5, the discounted price is rounded half down.

        For example, a price of €1.01 (centAmount: 101) with a 50% discount (permyriad: 5000) calculates to €0.505. Since the fractional half-cent is exactly 0.5, it rounds down to €0.50 (centAmount: 50).

      • When an absolute Product Discount exceeds the price of the Product Variant, the resulting discounted price is set to 0.

      Returns:
      value

    • getDiscount

      @NotNull @Valid @NotNull @Valid ProductDiscountReference getDiscount()

      ProductDiscount related to the discounted price.

      Returns:
      discount

    • setValue

      void setValue(TypedMoney value)

      Money value of the discounted price.

      • When a relative Product Discount applies and the fractional part of the resulting discounted price is 0.5, the discounted price is rounded half down.

        For example, a price of €1.01 (centAmount: 101) with a 50% discount (permyriad: 5000) calculates to €0.505. Since the fractional half-cent is exactly 0.5, it rounds down to €0.50 (centAmount: 50).

      • When an absolute Product Discount exceeds the price of the Product Variant, the resulting discounted price is set to 0.

      Parameters:
      value - value to be set

    • setDiscount

      void setDiscount(ProductDiscountReference discount)

      ProductDiscount related to the discounted price.

      Parameters:
      discount - value to be set

    • of

      static DiscountedPrice of()
      factory method
      Returns:
      instance of DiscountedPrice

    • of

      static DiscountedPrice of(DiscountedPrice template)
      factory method to create a shallow copy DiscountedPrice
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      DiscountedPrice copyDeep()

    • deepCopy

      @Nullable static DiscountedPrice deepCopy(@Nullable DiscountedPrice template)
      factory method to create a deep copy of DiscountedPrice
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static DiscountedPriceBuilder builder()
      builder factory method for DiscountedPrice
      Returns:
      builder

    • builder

      static DiscountedPriceBuilder builder(DiscountedPrice template)
      create builder for DiscountedPrice instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withDiscountedPrice

      default <T> T withDiscountedPrice(Function<DiscountedPrice,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static tools.jackson.core.type.TypeReference<DiscountedPrice> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference