Package com.commercetools.history.models.common

Interface TaxRate

public interface TaxRate

Shape of the value for addTaxRate and removeTaxRate actions

Example to create an instance using the builder pattern 

     TaxRate taxRate = TaxRate.builder()
             .id("{id}")
             .name("{name}")
             .amount(1)
             .includedInPrice(true)
             .country("{country}")
             .state("{state}")
             .plusSubRates(subRatesBuilder -> subRatesBuilder)
             .build()

  • Method Details

    • getId

      @NotNull @NotNull String getId()

      The ID is always set if the tax rate is part of a TaxCategory. The external tax rates in a Cart do not contain an id.

      Returns:
      id

    • getName

      @NotNull @NotNull String getName()
      Returns:
      name

    • getAmount

      @NotNull @NotNull Integer getAmount()

      Percentage in the range of [0..1]. The sum of the amounts of all subRates, if there are any.

      Returns:
      amount

    • getIncludedInPrice

      @NotNull @NotNull Boolean getIncludedInPrice()
      Returns:
      includedInPrice

    • getCountry

      @NotNull @NotNull String getCountry()

      Two-digit country code as per ISO 3166-1 alpha-2.

      Returns:
      country

    • getState

      @NotNull @NotNull String getState()

      The state in the country

      Returns:
      state

    • getSubRates

      @NotNull @Valid @NotNull @Valid List<SubRate> getSubRates()
      Returns:
      subRates

    • setId

      void setId(String id)

      The ID is always set if the tax rate is part of a TaxCategory. The external tax rates in a Cart do not contain an id.

      Parameters:
      id - value to be set

    • setName

      void setName(String name)
      set name
      Parameters:
      name - value to be set

    • setAmount

      void setAmount(Integer amount)

      Percentage in the range of [0..1]. The sum of the amounts of all subRates, if there are any.

      Parameters:
      amount - value to be set

    • setIncludedInPrice

      void setIncludedInPrice(Boolean includedInPrice)
      set includedInPrice
      Parameters:
      includedInPrice - value to be set

    • setCountry

      void setCountry(String country)

      Two-digit country code as per ISO 3166-1 alpha-2.

      Parameters:
      country - value to be set

    • setState

      void setState(String state)

      The state in the country

      Parameters:
      state - value to be set

    • setSubRates

      void setSubRates(SubRate... subRates)
      set subRates
      Parameters:
      subRates - values to be set

    • setSubRates

      void setSubRates(List<SubRate> subRates)
      set subRates
      Parameters:
      subRates - values to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static TaxRateBuilder builder()
      builder factory method for TaxRate
      Returns:
      builder

    • builder

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

    • withTaxRate

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