Package com.commercetools.api.models.inventory

Interface InventoryEntryChangeQuantityAction

All Superinterfaces:

InventoryEntryUpdateAction, ResourceUpdateAction<InventoryEntryUpdateAction>

public interface InventoryEntryChangeQuantityAction
extends InventoryEntryUpdateAction

Sets the quantityOnStock to an absolute value. This changes the availableQuantity, based on the number of active reservations. To make an incremental change instead, use the InventoryEntryAddQuantityAction update action.

Example to create an instance using the builder pattern

     InventoryEntryChangeQuantityAction inventoryEntryChangeQuantityAction = InventoryEntryChangeQuantityAction.builder()
             .quantity(0.3)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_QUANTITY	discriminator value for InventoryEntryChangeQuantityAction

Method Summary

Modifier and Type	Method	Description
static InventoryEntryChangeQuantityActionBuilder	builder()	builder factory method for InventoryEntryChangeQuantityAction
static InventoryEntryChangeQuantityActionBuilder	builder(InventoryEntryChangeQuantityAction template)	create builder for InventoryEntryChangeQuantityAction instance
InventoryEntryChangeQuantityAction	copyDeep()
static InventoryEntryChangeQuantityAction	deepCopy(InventoryEntryChangeQuantityAction template)	factory method to create a deep copy of InventoryEntryChangeQuantityAction
@NotNull Long	getQuantity()	Value to set for quantityOnStock.
static InventoryEntryChangeQuantityAction	of()	factory method
static InventoryEntryChangeQuantityAction	of(InventoryEntryChangeQuantityAction template)	factory method to create a shallow copy InventoryEntryChangeQuantityAction
void	setQuantity(Long quantity)	Value to set for quantityOnStock.
static com.fasterxml.jackson.core.type.TypeReference<InventoryEntryChangeQuantityAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withInventoryEntryChangeQuantityAction(Function<InventoryEntryChangeQuantityAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.inventory.InventoryEntryUpdateAction

getAction, withInventoryEntryUpdateAction

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

get

Field Details

CHANGE_QUANTITY

static final String CHANGE_QUANTITY

discriminator value for InventoryEntryChangeQuantityAction

See Also:

• Constant Field Values

Method Details

getQuantity

@NotNull
@NotNull Long getQuantity()

Value to set for quantityOnStock.

Returns:

quantity

setQuantity

void setQuantity(Long quantity)

Value to set for quantityOnStock.

Parameters:

quantity - value to be set

of

static InventoryEntryChangeQuantityAction of()

factory method

Returns:

instance of InventoryEntryChangeQuantityAction

of

static InventoryEntryChangeQuantityAction of(InventoryEntryChangeQuantityAction template)

factory method to create a shallow copy InventoryEntryChangeQuantityAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

InventoryEntryChangeQuantityAction copyDeep()

Specified by:

copyDeep in interface InventoryEntryUpdateAction

deepCopy

@Nullable
static InventoryEntryChangeQuantityAction deepCopy(@Nullable
 InventoryEntryChangeQuantityAction template)

factory method to create a deep copy of InventoryEntryChangeQuantityAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static InventoryEntryChangeQuantityActionBuilder builder()

builder factory method for InventoryEntryChangeQuantityAction

Returns:

builder

builder

static InventoryEntryChangeQuantityActionBuilder builder(InventoryEntryChangeQuantityAction template)

create builder for InventoryEntryChangeQuantityAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withInventoryEntryChangeQuantityAction

default <T> T withInventoryEntryChangeQuantityAction(Function<InventoryEntryChangeQuantityAction,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<InventoryEntryChangeQuantityAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference