Package com.commercetools.api.models.shopping_list

Interface ShoppingListRemoveLineItemAction

All Superinterfaces:

ResourceUpdateAction<ShoppingListUpdateAction>, ShoppingListUpdateAction

All Known Implementing Classes:

ShoppingListRemoveLineItemActionImpl

public interface ShoppingListRemoveLineItemAction
extends ShoppingListUpdateAction

ShoppingListRemoveLineItemAction Example to create an instance using the builder pattern

     ShoppingListRemoveLineItemAction shoppingListRemoveLineItemAction = ShoppingListRemoveLineItemAction.builder()
             .lineItemId("{lineItemId}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REMOVE_LINE_ITEM	discriminator value for ShoppingListRemoveLineItemAction

Method Summary

Modifier and Type	Method	Description
static ShoppingListRemoveLineItemActionBuilder	builder()	builder factory method for ShoppingListRemoveLineItemAction
static ShoppingListRemoveLineItemActionBuilder	builder(ShoppingListRemoveLineItemAction template)	create builder for ShoppingListRemoveLineItemAction instance
static ShoppingListRemoveLineItemAction	deepCopy(ShoppingListRemoveLineItemAction template)	factory method to create a deep copy of ShoppingListRemoveLineItemAction
@NotNull String	getLineItemId()	The id of the ShoppingListLineItem to update.
Long	getQuantity()	Amount to remove from the quantity of the ShoppingListLineItem.
static ShoppingListRemoveLineItemAction	of()	factory method
static ShoppingListRemoveLineItemAction	of(ShoppingListRemoveLineItemAction template)	factory method to create a shallow copy ShoppingListRemoveLineItemAction
void	setLineItemId(String lineItemId)	The id of the ShoppingListLineItem to update.
void	setQuantity(Long quantity)	Amount to remove from the quantity of the ShoppingListLineItem.
static com.fasterxml.jackson.core.type.TypeReference<ShoppingListRemoveLineItemAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withShoppingListRemoveLineItemAction(Function<ShoppingListRemoveLineItemAction,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_LINE_ITEM

static final String REMOVE_LINE_ITEM

discriminator value for ShoppingListRemoveLineItemAction

See Also:

• Constant Field Values

Method Details

getLineItemId

@NotNull
@NotNull String getLineItemId()

The id of the ShoppingListLineItem to update.

Returns:

lineItemId

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.

Parameters:

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

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