Package com.commercetools.api.models.error

Interface LineItemQuantityBelowLimitError

All Superinterfaces:
ErrorObject
public interface LineItemQuantityBelowLimitError extends ErrorObject

Returned when attempting to create or update a Cart with a Line Item whose quantity is below the minCartQuantity limit defined in the InventoryEntry for that Line Item's SKU.

Example to create an instance using the builder pattern 

     LineItemQuantityBelowLimitError lineItemQuantityBelowLimitError = LineItemQuantityBelowLimitError.builder()
             .message("{message}")
             .quantity(1)
             .minCartQuantity(1)
             .build()

  • Field Details

    • LINE_ITEM_QUANTITY_BELOW_LIMIT

      static final String LINE_ITEM_QUANTITY_BELOW_LIMIT
      discriminator value for LineItemQuantityBelowLimitError
      See Also:

  • Method Details

    • getCode

      @NotNull @NotNull String getCode()
      Description copied from interface: ErrorObject

      Error identifier.

      Specified by:
      getCode in interface ErrorObject
      Returns:
      code

    • getMessage

      @NotNull @NotNull String getMessage()

      "Quantity '$quantity' less than minimum '$minCartQuantity'."

      Specified by:
      getMessage in interface ErrorObject
      Returns:
      message

    • getQuantity

      @NotNull @NotNull Integer getQuantity()

      The quantity that was requested.

      Returns:
      quantity

    • getMinCartQuantity

      @NotNull @NotNull Integer getMinCartQuantity()

      The minimum quantity required for this Line Item.

      Returns:
      minCartQuantity

    • getLineItem

      String getLineItem()

      Reference to the Line Item that caused the error.

      Returns:
      lineItem

    • setMessage

      void setMessage(String message)

      "Quantity '$quantity' less than minimum '$minCartQuantity'."

      Specified by:
      setMessage in interface ErrorObject
      Parameters:
      message - value to be set

    • setQuantity

      void setQuantity(Integer quantity)

      The quantity that was requested.

      Parameters:
      quantity - value to be set

    • setMinCartQuantity

      void setMinCartQuantity(Integer minCartQuantity)

      The minimum quantity required for this Line Item.

      Parameters:
      minCartQuantity - value to be set

    • setLineItem

      void setLineItem(String lineItem)

      Reference to the Line Item that caused the error.

      Parameters:
      lineItem - value to be set

    • of

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

    • of

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

    • copyDeep

      LineItemQuantityBelowLimitError copyDeep()
      Specified by:
      copyDeep in interface ErrorObject

    • deepCopy

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

    • builder

      static LineItemQuantityBelowLimitErrorBuilder builder()
      builder factory method for LineItemQuantityBelowLimitError
      Returns:
      builder

    • builder

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

    • withLineItemQuantityBelowLimitError

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