Package com.commercetools.api.models.shopping_list

Interface ShoppingListRemoveTextLineItemAction

All Superinterfaces:
ResourceUpdateAction<ShoppingListUpdateAction>, ShoppingListUpdateAction
public interface ShoppingListRemoveTextLineItemAction extends ShoppingListUpdateAction
ShoppingListRemoveTextLineItemAction
Example to create an instance using the builder pattern 

     ShoppingListRemoveTextLineItemAction shoppingListRemoveTextLineItemAction = ShoppingListRemoveTextLineItemAction.builder()
             .build()

  • Field Details

    • REMOVE_TEXT_LINE_ITEM

      static final String REMOVE_TEXT_LINE_ITEM
      discriminator value for ShoppingListRemoveTextLineItemAction
      See Also:

  • Method Details

    • getTextLineItemId

      String getTextLineItemId()

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

      Returns:
      textLineItemId

    • getTextLineItemKey

      String getTextLineItemKey()

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

      Returns:
      textLineItemKey

    • getQuantity

      Long getQuantity()

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

      Returns:
      quantity

    • setTextLineItemId

      void setTextLineItemId(String textLineItemId)

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

      Parameters:
      textLineItemId - value to be set

    • setTextLineItemKey

      void setTextLineItemKey(String textLineItemKey)

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

      Parameters:
      textLineItemKey - value to be set

    • setQuantity

      void setQuantity(Long quantity)

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

      Parameters:
      quantity - value to be set

    • of

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

    • of

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

    • copyDeep

      ShoppingListRemoveTextLineItemAction copyDeep()
      Specified by:
      copyDeep in interface ShoppingListUpdateAction

    • deepCopy

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

    • builder

      static ShoppingListRemoveTextLineItemActionBuilder builder()
      builder factory method for ShoppingListRemoveTextLineItemAction
      Returns:
      builder

    • builder

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

    • withShoppingListRemoveTextLineItemAction

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