Package com.commercetools.api.models.me

Interface MyShoppingListRemoveLineItemAction

All Superinterfaces:

MyShoppingListUpdateAction, ResourceUpdateAction<MyShoppingListUpdateAction>

All Known Implementing Classes:

MyShoppingListRemoveLineItemActionImpl

public interface MyShoppingListRemoveLineItemAction
extends MyShoppingListUpdateAction

MyShoppingListRemoveLineItemAction Example to create an instance using the builder pattern

     MyShoppingListRemoveLineItemAction myShoppingListRemoveLineItemAction = MyShoppingListRemoveLineItemAction.builder()
             .lineItemId("{lineItemId}")
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static MyShoppingListRemoveLineItemActionBuilder	builder()	builder factory method for MyShoppingListRemoveLineItemAction
static MyShoppingListRemoveLineItemActionBuilder	builder(MyShoppingListRemoveLineItemAction template)	create builder for MyShoppingListRemoveLineItemAction instance
static MyShoppingListRemoveLineItemAction	deepCopy(MyShoppingListRemoveLineItemAction template)	factory method to create a deep copy of MyShoppingListRemoveLineItemAction
@NotNull String	getLineItemId()	The id of the ShoppingListLineItem to update.
Long	getQuantity()	Amount to remove from the quantity of the ShoppingListLineItem.
static MyShoppingListRemoveLineItemAction	of()	factory method
static MyShoppingListRemoveLineItemAction	of(MyShoppingListRemoveLineItemAction template)	factory method to create a shallow copy MyShoppingListRemoveLineItemAction
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<MyShoppingListRemoveLineItemAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMyShoppingListRemoveLineItemAction(Function<MyShoppingListRemoveLineItemAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.me.MyShoppingListUpdateAction

getAction, withMyShoppingListUpdateAction

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Field Details

REMOVE_LINE_ITEM

static final String REMOVE_LINE_ITEM

discriminator value for MyShoppingListRemoveLineItemAction

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 MyShoppingListRemoveLineItemAction of()

factory method

Returns:

instance of MyShoppingListRemoveLineItemAction

of

static MyShoppingListRemoveLineItemAction of(MyShoppingListRemoveLineItemAction template)

factory method to create a shallow copy MyShoppingListRemoveLineItemAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static MyShoppingListRemoveLineItemAction deepCopy(@Nullable
 MyShoppingListRemoveLineItemAction template)

factory method to create a deep copy of MyShoppingListRemoveLineItemAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyShoppingListRemoveLineItemActionBuilder builder()

builder factory method for MyShoppingListRemoveLineItemAction

Returns:

builder

builder

static MyShoppingListRemoveLineItemActionBuilder builder(MyShoppingListRemoveLineItemAction template)

create builder for MyShoppingListRemoveLineItemAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyShoppingListRemoveLineItemAction

default <T> T withMyShoppingListRemoveLineItemAction(Function<MyShoppingListRemoveLineItemAction,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<MyShoppingListRemoveLineItemAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference