Package com.commercetools.api.models.shipping_method

Interface CartClassificationTier

All Superinterfaces:
ShippingRatePriceTier
public interface CartClassificationTier extends ShippingRatePriceTier

The ShippingRate maps to an abstract Cart categorization expressed by strings (for example, Light, Medium, or Heavy).

Example to create an instance using the builder pattern 

     CartClassificationTier cartClassificationTier = CartClassificationTier.builder()
             .value("{value}")
             .price(priceBuilder -> priceBuilder)
             .build()

  • Field Details

    • CART_CLASSIFICATION

      static final String CART_CLASSIFICATION
      discriminator value for CartClassificationTier
      See Also:

  • Method Details

    • getValue

      @NotNull @NotNull String getValue()

      key selected from the values of the CartClassificationType configured in the Project.

      Returns:
      value

    • getPrice

      @NotNull @Valid @NotNull @Valid Money getPrice()

      Fixed shipping rate for the selected classification.

      Returns:
      price

    • getIsMatching

      Boolean getIsMatching()

      Appears in response to Get ShippingMethods for a Cart if the shipping rate matches the search query.

      Returns:
      isMatching

    • setValue

      void setValue(String value)

      key selected from the values of the CartClassificationType configured in the Project.

      Parameters:
      value - value to be set

    • setPrice

      void setPrice(Money price)

      Fixed shipping rate for the selected classification.

      Parameters:
      price - value to be set

    • setIsMatching

      void setIsMatching(Boolean isMatching)

      Appears in response to Get ShippingMethods for a Cart if the shipping rate matches the search query.

      Parameters:
      isMatching - value to be set

    • of

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

    • of

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

    • copyDeep

      CartClassificationTier copyDeep()
      Specified by:
      copyDeep in interface ShippingRatePriceTier

    • deepCopy

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

    • builder

      static CartClassificationTierBuilder builder()
      builder factory method for CartClassificationTier
      Returns:
      builder

    • builder

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

    • withCartClassificationTier

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