com.broadleafcommerce.inventory.advanced.service

Class DefaultInventoryLocationResolver

java.lang.Object

com.broadleafcommerce.inventory.advanced.service.DefaultInventoryLocationResolver

All Implemented Interfaces:

InventoryLocationResolver

@Component(value="blInventoryLocationResolver")
public class DefaultInventoryLocationResolver
extends Object
implements InventoryLocationResolver

This implementation simply looks up the default inventory location.

Author:

Phillip Verheyden (phillipuniverse)

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.common.persistence.EntityConfiguration	entityConfig
protected AdvancedInventoryService	inventoryService
protected FulfillmentLocationService	locationService

Constructor Summary

Constructors

Constructor and Description
DefaultInventoryLocationResolver()

Method Summary

Modifier and Type	Method and Description
FulfillmentLocation	resolveInventoryLocationForDecrement(org.broadleafcommerce.core.catalog.domain.Sku sku, Integer quantity, org.broadleafcommerce.core.order.domain.Order order) Resolves an inventory location when none has been determined from other means.
FulfillmentLocation	resolveInventoryLocationForIncrement(org.broadleafcommerce.core.catalog.domain.Sku sku, Integer quantity, org.broadleafcommerce.core.order.domain.Order order) This attempts to resolve an inventory location for incrementing inventory when a location is not known.
List<FulfillmentLocation>	resolveInventoryLocationsForAvailability(org.broadleafcommerce.core.catalog.domain.Sku sku, org.broadleafcommerce.core.order.domain.Order order) Resolves a list of locations to check for whether or not the given sku is available.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

locationService

protected FulfillmentLocationService locationService

inventoryService

protected AdvancedInventoryService inventoryService

entityConfig

protected org.broadleafcommerce.common.persistence.EntityConfiguration entityConfig

Constructor Detail

DefaultInventoryLocationResolver

public DefaultInventoryLocationResolver()

Method Detail

resolveInventoryLocationsForAvailability

public List<FulfillmentLocation> resolveInventoryLocationsForAvailability(org.broadleafcommerce.core.catalog.domain.Sku sku,
                                                                          org.broadleafcommerce.core.order.domain.Order order)

Description copied from interface: InventoryLocationResolver

Resolves a list of locations to check for whether or not the given sku is available. This can be used in the context of adding to cart or updating cart quantity OR in something from the frontend that is attempting to display the availability for the given sku

Specified by:

resolveInventoryLocationsForAvailability in interface InventoryLocationResolver

Parameters:

sku - the Sku to check for availability

order - an optional current order to use for determining which FulfillmentLocations to return

Returns:

a list of FulfillmentLocations that will be used to show the sku as available or not. This should return an empty list of no locations are available

See Also:

AdvancedInventoryServiceExtensionHandler#retrieveQuantitiesAvailable(java.util.Collection, java.util.Map, org.broadleafcommerce.common.extension.ExtensionResultHolder)}

resolveInventoryLocationForIncrement

public FulfillmentLocation resolveInventoryLocationForIncrement(org.broadleafcommerce.core.catalog.domain.Sku sku,
                                                                Integer quantity,
                                                                org.broadleafcommerce.core.order.domain.Order order)

Description copied from interface: InventoryLocationResolver

This attempts to resolve an inventory location for incrementing inventory when a location is not known. This is used within AdvancedInventoryServiceExtensionHandler.incrementInventory(java.util.Map, java.util.Map) when previous location information is not known

Specified by:

resolveInventoryLocationForIncrement in interface InventoryLocationResolver

Parameters:

sku - the Sku whose inventory will be incremented

quantity - the quantity that is going to be incremented

order - a contextual Order, may be null

Returns:

a FulfillmentLocation suitable to increment inventory for the given sku or null if a location could not be found

resolveInventoryLocationForDecrement

public FulfillmentLocation resolveInventoryLocationForDecrement(org.broadleafcommerce.core.catalog.domain.Sku sku,
                                                                Integer quantity,
                                                                org.broadleafcommerce.core.order.domain.Order order)

Description copied from interface: InventoryLocationResolver

Resolves an inventory location when none has been determined from other means. This is used when invoking InventoryService.decrementInventory(Sku, int) from the framework inventory service outside of the context of the blCheckoutWorkflow. If this is within the context of a blCheckoutWorkflow the InventoryReservationStrategy is used instead to determine which inventory reservations should be created.

Specified by:

resolveInventoryLocationForDecrement in interface InventoryLocationResolver

Parameters:

sku - the Sku that inventory will be decremented from

quantity - the quantitity that is going to be decremented

order - the current Order, usually given via the ContextualInventoryService via the ContextualInventoryService.ORDER_KEY. May be null

Returns:

a FulfillmentLocation suitable to increment inventory for the given sku or null if a location could not be found