Package com.commercetools.api.models.shopping_list

Interface ShoppingListRemoveTextLineItemAction

All Superinterfaces:

ResourceUpdateAction<ShoppingListUpdateAction>, ShoppingListUpdateAction

All Known Implementing Classes:

ShoppingListRemoveTextLineItemActionImpl

public interface ShoppingListRemoveTextLineItemAction
extends ShoppingListUpdateAction

ShoppingListRemoveTextLineItemAction Example to create an instance using the builder pattern

     ShoppingListRemoveTextLineItemAction shoppingListRemoveTextLineItemAction = ShoppingListRemoveTextLineItemAction.builder()
             .textLineItemId("{textLineItemId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_TEXT_LINE_ITEM	discriminator value for ShoppingListRemoveTextLineItemAction

Method Summary

Modifier and Type	Method	Description
static ShoppingListRemoveTextLineItemActionBuilder	builder()	builder factory method for ShoppingListRemoveTextLineItemAction
static ShoppingListRemoveTextLineItemActionBuilder	builder(ShoppingListRemoveTextLineItemAction template)	create builder for ShoppingListRemoveTextLineItemAction instance
static ShoppingListRemoveTextLineItemAction	deepCopy(ShoppingListRemoveTextLineItemAction template)	factory method to create a deep copy of ShoppingListRemoveTextLineItemAction
Long	getQuantity()	Amount to remove from the quantity of the TextLineItem.
@NotNull String	getTextLineItemId()	The id of the TextLineItem to update.
static ShoppingListRemoveTextLineItemAction	of()	factory method
static ShoppingListRemoveTextLineItemAction	of(ShoppingListRemoveTextLineItemAction template)	factory method to create a shallow copy ShoppingListRemoveTextLineItemAction
void	setQuantity(Long quantity)	Amount to remove from the quantity of the TextLineItem.
void	setTextLineItemId(String textLineItemId)	The id of the TextLineItem to update.
static com.fasterxml.jackson.core.type.TypeReference<ShoppingListRemoveTextLineItemAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withShoppingListRemoveTextLineItemAction(Function<ShoppingListRemoveTextLineItemAction,T> helper)	accessor map function

Methods 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

static final String REMOVE_TEXT_LINE_ITEM

discriminator value for ShoppingListRemoveTextLineItemAction

See Also:

• Constant Field Values

Method Details

getTextLineItemId

@NotNull
@NotNull String getTextLineItemId()

The id of the TextLineItem to update.

Returns:

textLineItemId

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.

Parameters:

textLineItemId - 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

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