Interface ShoppingListRemoveTextLineItemAction
- All Superinterfaces:
ResourceUpdateAction<ShoppingListUpdateAction>
,ShoppingListUpdateAction
- All Known Implementing Classes:
ShoppingListRemoveTextLineItemActionImpl
ShoppingListRemoveTextLineItemAction
Example to create an instance using the builder pattern
Example to create an instance using the builder pattern
ShoppingListRemoveTextLineItemAction shoppingListRemoveTextLineItemAction = ShoppingListRemoveTextLineItemAction.builder()
.textLineItemId("{textLineItemId}")
.build()
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
discriminator value for ShoppingListRemoveTextLineItemAction -
Method Summary
Modifier and TypeMethodDescriptionbuilder()
builder factory method for ShoppingListRemoveTextLineItemActionbuilder
(ShoppingListRemoveTextLineItemAction template) create builder for ShoppingListRemoveTextLineItemAction instancedeepCopy
(ShoppingListRemoveTextLineItemAction template) factory method to create a deep copy of ShoppingListRemoveTextLineItemActionAmount to remove from thequantity
of the TextLineItem.@NotNull String
Theid
of the TextLineItem to update.of()
factory methodof
(ShoppingListRemoveTextLineItemAction template) factory method to create a shallow copy ShoppingListRemoveTextLineItemActionvoid
setQuantity
(Long quantity) Amount to remove from thequantity
of the TextLineItem.void
setTextLineItemId
(String textLineItemId) Theid
of the TextLineItem to update.static com.fasterxml.jackson.core.type.TypeReference<ShoppingListRemoveTextLineItemAction>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
accessor map functionMethods inherited from interface com.commercetools.api.models.ResourceUpdateAction
get
Methods inherited from interface com.commercetools.api.models.shopping_list.ShoppingListUpdateAction
getAction, withShoppingListUpdateAction
-
Field Details
-
REMOVE_TEXT_LINE_ITEM
discriminator value for ShoppingListRemoveTextLineItemAction- See Also:
-
-
Method Details
-
getTextLineItemId
The
id
of the TextLineItem to update.- Returns:
- textLineItemId
-
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 currentquantity
of the TextLineItem, the TextLineItem is removed from the ShoppingList.- Returns:
- quantity
-
setTextLineItemId
The
id
of the TextLineItem to update.- Parameters:
textLineItemId
- value to be set
-
setQuantity
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 currentquantity
of the TextLineItem, the TextLineItem is removed from the ShoppingList.- Parameters:
quantity
- value to be set
-
of
factory method- Returns:
- instance of ShoppingListRemoveTextLineItemAction
-
of
factory method to create a shallow copy ShoppingListRemoveTextLineItemAction- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
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
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
-