Package com.commercetools.api.models.error

Interface LineItemQuantityAboveLimitError

All Superinterfaces:
ErrorObject
public interface LineItemQuantityAboveLimitError extends ErrorObject

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

Example to create an instance using the builder pattern 

     LineItemQuantityAboveLimitError lineItemQuantityAboveLimitError = LineItemQuantityAboveLimitError.builder()
             .message("{message}")
             .quantity(1)
             .maxCartQuantity(1)
             .build()

  • Field Details

    • LINE_ITEM_QUANTITY_ABOVE_LIMIT

      static final String LINE_ITEM_QUANTITY_ABOVE_LIMIT
      discriminator value for LineItemQuantityAboveLimitError
      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' greater than maximum '$maxCartQuantity'."

      Specified by:
      getMessage in interface ErrorObject
      Returns:
      message

    • getQuantity

      @NotNull @NotNull Integer getQuantity()

      The quantity that was requested.

      Returns:
      quantity

    • getMaxCartQuantity

      @NotNull @NotNull Integer getMaxCartQuantity()

      The maximum quantity allowed for this Line Item.

      Returns:
      maxCartQuantity

    • getLineItem

      String getLineItem()

      Reference to the Line Item that caused the error.

      Returns:
      lineItem

    • setMessage

      void setMessage(String message)

      "Quantity '$quantity' greater than maximum '$maxCartQuantity'."

      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

    • setMaxCartQuantity

      void setMaxCartQuantity(Integer maxCartQuantity)

      The maximum quantity allowed for this Line Item.

      Parameters:
      maxCartQuantity - 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 LineItemQuantityAboveLimitError of()
      factory method
      Returns:
      instance of LineItemQuantityAboveLimitError

    • of

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

    • copyDeep

      LineItemQuantityAboveLimitError copyDeep()
      Specified by:
      copyDeep in interface ErrorObject

    • deepCopy

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

    • builder

      static LineItemQuantityAboveLimitErrorBuilder builder()
      builder factory method for LineItemQuantityAboveLimitError
      Returns:
      builder

    • builder

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

    • withLineItemQuantityAboveLimitError

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