Package com.commercetools.history.models.change_value

Interface InventoryQuantityValue

All Known Implementing Classes:

InventoryQuantityValueImpl

public interface InventoryQuantityValue

InventoryQuantityValue Example to create an instance using the builder pattern

     InventoryQuantityValue inventoryQuantityValue = InventoryQuantityValue.builder()
             .quantityOnStock(1)
             .availableQuantity(1)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static InventoryQuantityValueBuilder	builder()	builder factory method for InventoryQuantityValue
static InventoryQuantityValueBuilder	builder(InventoryQuantityValue template)	create builder for InventoryQuantityValue instance
static InventoryQuantityValue	deepCopy(InventoryQuantityValue template)	factory method to create a deep copy of InventoryQuantityValue
@NotNull Integer	getAvailableQuantity()	Available amount of stock (quantityOnStock - reserved).
@NotNull Integer	getQuantityOnStock()	Overall amount of stock (availableQuantity + reserved).
static InventoryQuantityValue	of()	factory method
static InventoryQuantityValue	of(InventoryQuantityValue template)	factory method to create a shallow copy InventoryQuantityValue
void	setAvailableQuantity(Integer availableQuantity)	Available amount of stock (quantityOnStock - reserved).
void	setQuantityOnStock(Integer quantityOnStock)	Overall amount of stock (availableQuantity + reserved).
static com.fasterxml.jackson.core.type.TypeReference<InventoryQuantityValue>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withInventoryQuantityValue(Function<InventoryQuantityValue,T> helper)	accessor map function

Method Details

getQuantityOnStock

@NotNull
@NotNull Integer getQuantityOnStock()

Overall amount of stock (availableQuantity + reserved).

Returns:

quantityOnStock

getAvailableQuantity

@NotNull
@NotNull Integer getAvailableQuantity()

Available amount of stock (quantityOnStock - reserved).

Returns:

availableQuantity

setQuantityOnStock

void setQuantityOnStock(Integer quantityOnStock)

Overall amount of stock (availableQuantity + reserved).

Parameters:

quantityOnStock - value to be set

setAvailableQuantity

void setAvailableQuantity(Integer availableQuantity)

Available amount of stock (quantityOnStock - reserved).

Parameters:

availableQuantity - value to be set

of

static InventoryQuantityValue of()

factory method

Returns:

instance of InventoryQuantityValue

of

static InventoryQuantityValue of(InventoryQuantityValue template)

factory method to create a shallow copy InventoryQuantityValue

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static InventoryQuantityValue deepCopy(@Nullable
 InventoryQuantityValue template)

factory method to create a deep copy of InventoryQuantityValue

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static InventoryQuantityValueBuilder builder()

builder factory method for InventoryQuantityValue

Returns:

builder

builder

static InventoryQuantityValueBuilder builder(InventoryQuantityValue template)

create builder for InventoryQuantityValue instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withInventoryQuantityValue

default <T> T withInventoryQuantityValue(Function<InventoryQuantityValue,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<InventoryQuantityValue> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference