Package com.commercetools.api.models.product

Interface ProductSetDiscountedPriceAction

All Superinterfaces:
ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>
public interface ProductSetDiscountedPriceAction extends ProductUpdateAction

Produces the ProductPriceExternalDiscountSet Message.

Example to create an instance using the builder pattern 

     ProductSetDiscountedPriceAction productSetDiscountedPriceAction = ProductSetDiscountedPriceAction.builder()
             .priceId("{priceId}")
             .build()

  • Field Details

    • SET_DISCOUNTED_PRICE

      static final String SET_DISCOUNTED_PRICE
      discriminator value for ProductSetDiscountedPriceAction
      See Also:

  • Method Details

    • getPriceId

      @NotNull @NotNull String getPriceId()

      The id of the Price to set the Discount.

      Returns:
      priceId

    • getStaged

      Boolean getStaged()

      If true, only the staged Embedded Price is updated. If false, both the current and staged Embedded Price are updated.

      Returns:
      staged

    • getDiscounted

      @Valid @Valid DiscountedPriceDraft getDiscounted()

      Value to set. If empty, any existing value will be removed. The referenced ProductDiscount must have the Type external, be active, and its predicate must match the referenced Price.

      Returns:
      discounted

    • setPriceId

      void setPriceId(String priceId)

      The id of the Price to set the Discount.

      Parameters:
      priceId - value to be set

    • setStaged

      void setStaged(Boolean staged)

      If true, only the staged Embedded Price is updated. If false, both the current and staged Embedded Price are updated.

      Parameters:
      staged - value to be set

    • setDiscounted

      void setDiscounted(DiscountedPriceDraft discounted)

      Value to set. If empty, any existing value will be removed. The referenced ProductDiscount must have the Type external, be active, and its predicate must match the referenced Price.

      Parameters:
      discounted - value to be set

    • of

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

    • of

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

    • copyDeep

      ProductSetDiscountedPriceAction copyDeep()
      Specified by:
      copyDeep in interface ProductUpdateAction

    • deepCopy

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

    • builder

      static ProductSetDiscountedPriceActionBuilder builder()
      builder factory method for ProductSetDiscountedPriceAction
      Returns:
      builder

    • builder

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

    • withProductSetDiscountedPriceAction

      default <T> T withProductSetDiscountedPriceAction(Function<ProductSetDiscountedPriceAction,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<ProductSetDiscountedPriceAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference