Package com.commercetools.api.models.tax_category

Interface TaxCategoryReplaceTaxRateAction

All Superinterfaces:
ResourceUpdateAction<TaxCategoryUpdateAction>, TaxCategoryUpdateAction
public interface TaxCategoryReplaceTaxRateAction extends TaxCategoryUpdateAction
TaxCategoryReplaceTaxRateAction
Example to create an instance using the builder pattern 

     TaxCategoryReplaceTaxRateAction taxCategoryReplaceTaxRateAction = TaxCategoryReplaceTaxRateAction.builder()
             .taxRate(taxRateBuilder -> taxRateBuilder)
             .build()

  • Field Details

    • REPLACE_TAX_RATE

      static final String REPLACE_TAX_RATE
      discriminator value for TaxCategoryReplaceTaxRateAction
      See Also:

  • Method Details

    • getTaxRateId

      String getTaxRateId()

      ID of the TaxRate to replace. Either taxRateId or taxRateKey must be provided.

      If the referenced TaxRate does not exist within the TaxCategory, an InvalidOperation error is returned.

      Returns:
      taxRateId

    • getTaxRateKey

      String getTaxRateKey()

      Key of the TaxRate to replace. Either taxRateId or taxRateKey must be provided.

      If the referenced TaxRate does not exist within the TaxCategory, an InvalidOperation error is returned.

      Returns:
      taxRateKey

    • getTaxRate

      @NotNull @Valid @NotNull @Valid TaxRateDraft getTaxRate()

      New TaxRate to replace with.

      Returns:
      taxRate

    • setTaxRateId

      void setTaxRateId(String taxRateId)

      ID of the TaxRate to replace. Either taxRateId or taxRateKey must be provided.

      If the referenced TaxRate does not exist within the TaxCategory, an InvalidOperation error is returned.

      Parameters:
      taxRateId - value to be set

    • setTaxRateKey

      void setTaxRateKey(String taxRateKey)

      Key of the TaxRate to replace. Either taxRateId or taxRateKey must be provided.

      If the referenced TaxRate does not exist within the TaxCategory, an InvalidOperation error is returned.

      Parameters:
      taxRateKey - value to be set

    • setTaxRate

      void setTaxRate(TaxRateDraft taxRate)

      New TaxRate to replace with.

      Parameters:
      taxRate - value to be set

    • of

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

    • of

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

    • copyDeep

      TaxCategoryReplaceTaxRateAction copyDeep()
      Specified by:
      copyDeep in interface TaxCategoryUpdateAction

    • deepCopy

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

    • builder

      static TaxCategoryReplaceTaxRateActionBuilder builder()
      builder factory method for TaxCategoryReplaceTaxRateAction
      Returns:
      builder

    • builder

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

    • withTaxCategoryReplaceTaxRateAction

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