com.broadleafcommerce.inventory.advanced.domain

Interface InventoryReservation

All Superinterfaces:

Serializable

All Known Implementing Classes:

InventoryReservationImpl

public interface InventoryReservation
extends Serializable

Quantity reserved for a particular FulfillmentGroupItem within an FulfillmentLocation. If a single FulfillmentGroupItem can be fulfilled in multiple locations, then a FulfillmentGroupItem will have multiple InventoryReservation records corresponding to each unique FulfillmentLocation that it can be fulfilled at. However, the sum of all of the quantities for all of the inventory reservations for a fulfillment group item should not exceed the quantity of the FulfillmentGroupItem itself.

Author:

Phillip Verheyden (phillipuniverse)

See Also:

InventoryReservationStrategy}

Method Summary

Modifier and Type	Method and Description
Long	getId() Gets the primary key
org.broadleafcommerce.core.order.domain.FulfillmentGroupItem	getItem() The fulfillment item from the order that this inventory was reserved for.
FulfillmentLocation	getLocation() The location for which the inventory is actually coming out of
Integer	getQuantity() Obtains the quantity that was reserved at the fulfillment location for the fulfillment item.
org.broadleafcommerce.core.catalog.domain.Sku	getSku() A transient value representing the Sku that the getItem() was used to lookup quantity.
void	setId(Long id) Sets the primary key for this reservation
void	setItem(org.broadleafcommerce.core.order.domain.FulfillmentGroupItem item) Sets the item that this inventory was reserved for
void	setLocation(FulfillmentLocation location) Sets the location where this inventory should be decremented from
void	setQuantity(Integer quantity) Sets the quantity.
void	setSku(org.broadleafcommerce.core.catalog.domain.Sku sku) Sets the transient value representing the Sku that the getItem() was used to lookup quantity for

Method Detail

getId

Long getId()

Gets the primary key

Returns:

the primary key for this reservation

setId

void setId(Long id)

Sets the primary key for this reservation

Parameters:

id - the new primary key

getQuantity

Integer getQuantity()

Obtains the quantity that was reserved at the fulfillment location for the fulfillment item. This is not necessarily equivalent to FulfillmentGroupItem.getQuantity(), as it is possible that a single FulfillmentGroupItem has reserved inventory in multiple FulfillmentLocation

Returns:

setQuantity

void setQuantity(Integer quantity)

Sets the quantity.

Parameters:

quantity -

getLocation

FulfillmentLocation getLocation()

The location for which the inventory is actually coming out of

Returns:

the location that the quantity will come out of

setLocation

void setLocation(FulfillmentLocation location)

Sets the location where this inventory should be decremented from

Parameters:

location - the FulfillmentLocation that was used to reserve getQuantity()

getItem

org.broadleafcommerce.core.order.domain.FulfillmentGroupItem getItem()

The fulfillment item from the order that this inventory was reserved for.

Returns:

setItem

void setItem(org.broadleafcommerce.core.order.domain.FulfillmentGroupItem item)

Sets the item that this inventory was reserved for

Parameters:

item -

getSku

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

A transient value representing the Sku that the getItem() was used to lookup quantity. This is determined from the FulfillmentGroupItem and is set when first creating the reservation

Returns:

the Sku that inventory should come from

setSku

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

Sets the transient value representing the Sku that the getItem() was used to lookup quantity for

Parameters:

sku -