Package com.commercetools.api.models.message

Interface InventoryEntrySafetyStockMessage

All Superinterfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, Versioned<Message>

public interface InventoryEntrySafetyStockMessage
extends Message

Generated after InventoryEntry quantityOnStock reaches the configured safety stock level. For more information, see InventoryEntryStockLevels.

Example to create an instance using the builder pattern

     InventoryEntrySafetyStockMessage inventoryEntrySafetyStockMessage = InventoryEntrySafetyStockMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .sku("{sku}")
             .quantityOnStock(0.3)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INVENTORY_ENTRY_SAFETY_STOCK	discriminator value for InventoryEntrySafetyStockMessage

Method Summary

Modifier and Type	Method	Description
static InventoryEntrySafetyStockMessageBuilder	builder()	builder factory method for InventoryEntrySafetyStockMessage
static InventoryEntrySafetyStockMessageBuilder	builder(InventoryEntrySafetyStockMessage template)	create builder for InventoryEntrySafetyStockMessage instance
InventoryEntrySafetyStockMessage	copyDeep()
static InventoryEntrySafetyStockMessage	deepCopy(InventoryEntrySafetyStockMessage template)	factory method to create a deep copy of InventoryEntrySafetyStockMessage
@NotNull Integer	getQuantityOnStock()	The quantityOnStock of the InventoryEntry at the time the safety stock level was reached.
@NotNull String	getSku()	The sku of the InventoryEntry whose quantityOnStock reached the configured safety stock level.
@Valid ChannelReference	getSupplyChannel()	Reference to the Channel where the InventoryEntry quantityOnStock reached the configured safety stock level.
static InventoryEntrySafetyStockMessage	of()	factory method
static InventoryEntrySafetyStockMessage	of(InventoryEntrySafetyStockMessage template)	factory method to create a shallow copy InventoryEntrySafetyStockMessage
void	setQuantityOnStock(Integer quantityOnStock)	The quantityOnStock of the InventoryEntry at the time the safety stock level was reached.
void	setSku(String sku)	The sku of the InventoryEntry whose quantityOnStock reached the configured safety stock level.
void	setSupplyChannel(ChannelReference supplyChannel)	Reference to the Channel where the InventoryEntry quantityOnStock reached the configured safety stock level.
static com.fasterxml.jackson.core.type.TypeReference<InventoryEntrySafetyStockMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withInventoryEntrySafetyStockMessage(Function<InventoryEntrySafetyStockMessage,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

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

get

Methods inherited from interface com.commercetools.api.models.message.Message

getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage

Field Details

INVENTORY_ENTRY_SAFETY_STOCK

static final String INVENTORY_ENTRY_SAFETY_STOCK

discriminator value for InventoryEntrySafetyStockMessage

See Also:

• Constant Field Values

Method Details

getSku

@NotNull
@NotNull String getSku()

The sku of the InventoryEntry whose quantityOnStock reached the configured safety stock level.

Returns:

sku

getQuantityOnStock

@NotNull
@NotNull Integer getQuantityOnStock()

The quantityOnStock of the InventoryEntry at the time the safety stock level was reached.

Returns:

quantityOnStock

getSupplyChannel

@Valid
@Valid ChannelReference getSupplyChannel()

Reference to the Channel where the InventoryEntry quantityOnStock reached the configured safety stock level.

Returns:

supplyChannel

setSku

void setSku(String sku)

The sku of the InventoryEntry whose quantityOnStock reached the configured safety stock level.

Parameters:

sku - value to be set

setQuantityOnStock

void setQuantityOnStock(Integer quantityOnStock)

The quantityOnStock of the InventoryEntry at the time the safety stock level was reached.

Parameters:

quantityOnStock - value to be set

setSupplyChannel

void setSupplyChannel(ChannelReference supplyChannel)

Reference to the Channel where the InventoryEntry quantityOnStock reached the configured safety stock level.

Parameters:

supplyChannel - value to be set

of

static InventoryEntrySafetyStockMessage of()

factory method

Returns:

instance of InventoryEntrySafetyStockMessage

of

static InventoryEntrySafetyStockMessage of(InventoryEntrySafetyStockMessage template)

factory method to create a shallow copy InventoryEntrySafetyStockMessage

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

InventoryEntrySafetyStockMessage copyDeep()

Specified by:

copyDeep in interface BaseResource

Specified by:

copyDeep in interface Message

deepCopy

@Nullable
static InventoryEntrySafetyStockMessage deepCopy(@Nullable
 InventoryEntrySafetyStockMessage template)

factory method to create a deep copy of InventoryEntrySafetyStockMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static InventoryEntrySafetyStockMessageBuilder builder()

builder factory method for InventoryEntrySafetyStockMessage

Returns:

builder

builder

static InventoryEntrySafetyStockMessageBuilder builder(InventoryEntrySafetyStockMessage template)

create builder for InventoryEntrySafetyStockMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withInventoryEntrySafetyStockMessage

default <T> T withInventoryEntrySafetyStockMessage(Function<InventoryEntrySafetyStockMessage,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<InventoryEntrySafetyStockMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference