com.broadleafcommerce.inventory.advanced.domain

Interface Inventory

All Superinterfaces:

Serializable

All Known Implementing Classes:

InventoryImpl

public interface Inventory
extends Serializable

Inventory should be pretty self-explanatory: this is the amount of a Sku that is available at a particular Location.

Author:

Phillip Verheyden (phillipuniverse)

Method Summary

Modifier and Type	Method and Description
FulfillmentLocation	getFulfillmentLocation() Retrieves the fulfillment location information related to this inventory
Long	getId() Retrieves the unique identifier of the Inventory
Integer	getQuantityAvailable() Retrieves the inventory available for sale.
Integer	getQuantityOnHand() Retrieves the actual inventory in possession of the business
org.broadleafcommerce.core.catalog.domain.Sku	getSku() Retrieves the sku for this Inventory
Long	getVersion() Retrieves the version set by Hibernate.
void	setFulfillmentLocation(FulfillmentLocation fulfillmentLocation) Sets the fulfillment location information related to this inventory
void	setId(Long id) Sets the unique identifier of the Inventory
void	setQuantityAvailable(Integer quantity) Sets the inventory available for sale.
void	setQuantityOnHand(Integer quantity) Sets the actual inventory in possession of the business
void	setSku(org.broadleafcommerce.core.catalog.domain.Sku sku) Sets the sku for this Inventory

Method Detail

getId

Long getId()

Retrieves the unique identifier of the Inventory

Returns:

id

setId

void setId(Long id)

Sets the unique identifier of the Inventory

Parameters:

id -

getFulfillmentLocation

FulfillmentLocation getFulfillmentLocation()

Retrieves the fulfillment location information related to this inventory

Returns:

FulfillmentLocation

setFulfillmentLocation

void setFulfillmentLocation(FulfillmentLocation fulfillmentLocation)

Sets the fulfillment location information related to this inventory

Parameters:

fulfillmentLocation -

getSku

org.broadleafcommerce.core.catalog.domain.Sku getSku()

Retrieves the sku for this Inventory

Returns:

sku

setSku

void setSku(org.broadleafcommerce.core.catalog.domain.Sku sku)

Sets the sku for this Inventory

Parameters:

sku -

getQuantityOnHand

Integer getQuantityOnHand()

Retrieves the actual inventory in possession of the business

Returns:

quantity

setQuantityOnHand

void setQuantityOnHand(Integer quantity)

Sets the actual inventory in possession of the business

Parameters:

quantity -

getQuantityAvailable

Integer getQuantityAvailable()

Retrieves the inventory available for sale. This is typically the difference of quantity on hand reduced by the inventory allocated for existing orders.

Returns:

quantityAvailable

setQuantityAvailable

void setQuantityAvailable(Integer quantity)

Sets the inventory available for sale.

Parameters:

quantity -

getVersion

Long getVersion()

Retrieves the version set by Hibernate. Version has a getter only as this should never be set by the system and is only used for optimistic locking

Returns: