Package com.commercetools.api.models.shopping_list

Interface ShoppingListRemoveLineItemAction

All Superinterfaces:
ResourceUpdateAction<ShoppingListUpdateAction>, ShoppingListUpdateAction
public interface ShoppingListRemoveLineItemAction extends ShoppingListUpdateAction

Produces the Shopping List Line Item Removed Message.

Example to create an instance using the builder pattern 

     ShoppingListRemoveLineItemAction shoppingListRemoveLineItemAction = ShoppingListRemoveLineItemAction.builder()
             .build()

  • Field Details

    • REMOVE_LINE_ITEM

      static final String REMOVE_LINE_ITEM
      discriminator value for ShoppingListRemoveLineItemAction
      See Also:

  • Method Details

    • getLineItemId

      String getLineItemId()

      The id of the ShoppingListLineItem to update. Either lineItemId or lineItemKey is required.

      Returns:
      lineItemId

    • getLineItemKey

      String getLineItemKey()

      The key of the ShoppingListLineItem to update. Either lineItemId or lineItemKey is required.

      Returns:
      lineItemKey

    • getQuantity

      Long getQuantity()

      Amount to remove from the quantity of the ShoppingListLineItem. If not set, the ShoppingListLineItem is removed from the ShoppingList. If this value matches or exceeds the current quantity of the ShoppingListLineItem, the ShoppingListLineItem is removed from the ShoppingList.

      Returns:
      quantity

    • setLineItemId

      void setLineItemId(String lineItemId)

      The id of the ShoppingListLineItem to update. Either lineItemId or lineItemKey is required.

      Parameters:
      lineItemId - value to be set

    • setLineItemKey

      void setLineItemKey(String lineItemKey)

      The key of the ShoppingListLineItem to update. Either lineItemId or lineItemKey is required.

      Parameters:
      lineItemKey - value to be set

    • setQuantity

      void setQuantity(Long quantity)

      Amount to remove from the quantity of the ShoppingListLineItem. If not set, the ShoppingListLineItem is removed from the ShoppingList. If this value matches or exceeds the current quantity of the ShoppingListLineItem, the ShoppingListLineItem is removed from the ShoppingList.

      Parameters:
      quantity - value to be set

    • of

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

    • of

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

    • copyDeep

      ShoppingListRemoveLineItemAction copyDeep()
      Specified by:
      copyDeep in interface ShoppingListUpdateAction

    • deepCopy

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

    • builder

      static ShoppingListRemoveLineItemActionBuilder builder()
      builder factory method for ShoppingListRemoveLineItemAction
      Returns:
      builder

    • builder

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

    • withShoppingListRemoveLineItemAction

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