Class SkuInventory
- java.lang.Object
-
- com.broadleafcommerce.inventory.domain.SkuInventory
-
- All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware,Serializable
public class SkuInventory extends Object implements Serializable, com.broadleafcommerce.data.tracking.core.ContextStateAware
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description SkuInventory()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected booleancanEqual(Object other)booleanequals(Object o)com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextStategetContextState()StringgetId()This is the contextId of the Sku Inventory record.StringgetInventoryLocationContextId()The ID of theInventoryLocationassociated with thisSkuInventoryrecord.IntegergetQuantityAvailable()Summary field to indicate how many are available at this location.IntegergetQuantityOnHand()Number of physical items that are expected to be available if an inventory count was done.IntegergetQuantityOnOrder()Number of items that have been ordered and are expected to arrive in the warehouse.IntegergetQuantityReserved()Number of items that have been reserved but that have not been fulfilled.IntegergetSafetyStock()An optional field that indicates how many should be reserved in the count or calculation of availability.SkuRefgetSkuRef()A soft reference to the SKU for which this inventory is managed.StringgetVendorRef()Soft reference to the vendor associated with this sku inventory.inthashCode()voidsetContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)voidsetId(String id)This is the contextId of the Sku Inventory record.voidsetInventoryLocationContextId(String inventoryLocationContextId)The ID of theInventoryLocationassociated with thisSkuInventoryrecord.voidsetQuantityAvailable(Integer quantityAvailable)Summary field to indicate how many are available at this location.voidsetQuantityOnHand(Integer quantityOnHand)Number of physical items that are expected to be available if an inventory count was done.voidsetQuantityOnOrder(Integer quantityOnOrder)Number of items that have been ordered and are expected to arrive in the warehouse.voidsetQuantityReserved(Integer quantityReserved)Number of items that have been reserved but that have not been fulfilled.voidsetSafetyStock(Integer safetyStock)An optional field that indicates how many should be reserved in the count or calculation of availability.voidsetSkuRef(SkuRef skuRef)A soft reference to the SKU for which this inventory is managed.voidsetVendorRef(String vendorRef)Soft reference to the vendor associated with this sku inventory.StringtoString()
-
-
-
Method Detail
-
getId
public String getId()
This is the contextId of the Sku Inventory record.
-
getQuantityAvailable
public Integer getQuantityAvailable()
Summary field to indicate how many are available at this location. This is a calculated field (quantityOnHand - quantityReserved - safetyStock). This field must add up to the difference of these values.
-
getQuantityReserved
public Integer getQuantityReserved()
Number of items that have been reserved but that have not been fulfilled.
-
getQuantityOnHand
public Integer getQuantityOnHand()
Number of physical items that are expected to be available if an inventory count was done.
-
getQuantityOnOrder
public Integer getQuantityOnOrder()
Number of items that have been ordered and are expected to arrive in the warehouse.
-
getSafetyStock
public Integer getSafetyStock()
An optional field that indicates how many should be reserved in the count or calculation of availability.
-
getInventoryLocationContextId
public String getInventoryLocationContextId()
The ID of theInventoryLocationassociated with thisSkuInventoryrecord.
-
getSkuRef
public SkuRef getSkuRef()
A soft reference to the SKU for which this inventory is managed.
-
getVendorRef
@Nullable public String getVendorRef()
Soft reference to the vendor associated with this sku inventory. This value can be null, in which case, no vendor is associated.- Returns:
- Soft reference to the vendor associated with this location.
-
getContextState
public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
- Specified by:
getContextStatein interfacecom.broadleafcommerce.data.tracking.core.ContextStateAware
-
setId
public void setId(String id)
This is the contextId of the Sku Inventory record.
-
setQuantityAvailable
public void setQuantityAvailable(Integer quantityAvailable)
Summary field to indicate how many are available at this location. This is a calculated field (quantityOnHand - quantityReserved - safetyStock). This field must add up to the difference of these values.
-
setQuantityReserved
public void setQuantityReserved(Integer quantityReserved)
Number of items that have been reserved but that have not been fulfilled.
-
setQuantityOnHand
public void setQuantityOnHand(Integer quantityOnHand)
Number of physical items that are expected to be available if an inventory count was done.
-
setQuantityOnOrder
public void setQuantityOnOrder(Integer quantityOnOrder)
Number of items that have been ordered and are expected to arrive in the warehouse.
-
setSafetyStock
public void setSafetyStock(Integer safetyStock)
An optional field that indicates how many should be reserved in the count or calculation of availability.
-
setInventoryLocationContextId
public void setInventoryLocationContextId(String inventoryLocationContextId)
The ID of theInventoryLocationassociated with thisSkuInventoryrecord.
-
setSkuRef
public void setSkuRef(SkuRef skuRef)
A soft reference to the SKU for which this inventory is managed.
-
setVendorRef
public void setVendorRef(@Nullable String vendorRef)Soft reference to the vendor associated with this sku inventory. This value can be null, in which case, no vendor is associated.- Parameters:
vendorRef- Soft reference to the vendor associated with this location.
-
setContextState
public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
- Specified by:
setContextStatein interfacecom.broadleafcommerce.data.tracking.core.ContextStateAware
-
canEqual
protected boolean canEqual(Object other)
-
-