com.broadleafcommerce.inventory.advanced.service

Interface FulfillmentLocationService

All Known Implementing Classes:

FulfillmentLocationServiceImpl

public interface FulfillmentLocationService

Author:

Phillip Verheyden (phillipuniverse)

Method Summary

Modifier and Type	Method and Description
FulfillmentLocation	createNew() Creates a new instance of a FulfillmentLocation.
void	delete(FulfillmentLocation fulfillmentLocation) Deletes the passed FulfillmentLocation
List<FulfillmentLocation>	findAll() Retrieves all of the fulfillment locations
List<FulfillmentLocation>	findAllFulfillmentLocations(org.broadleafcommerce.core.order.service.type.FulfillmentType fulfillmentType) Gets all of the fulfillment locations for the specified fulfillment type.
List<FulfillmentLocation>	findAllFulfillmentLocationsForSku(Long skuId) Returns all fulfillment locations associated with a Sku.
List<FulfillmentLocation>	findAllFulfillmentLocationsForSku(Long skuId, org.broadleafcommerce.core.order.service.type.FulfillmentType fulfillmentType) Returns all fulfillment locations associated with a sku for a particular fulfillment type.
List<FulfillmentLocation>	findAllFulfillmentLocationsForSku(Long skuId, org.broadleafcommerce.core.order.service.type.FulfillmentType fulfillmentType, int minimumQuantity) Returns all fulfillment locations associated with a sku for a particular fulfillment type and has at least enough inventory as quantity.
FulfillmentLocation	findById(Long fulfillmentLocationId) Retrieves a FulfillmentLocation from the given id
FulfillmentLocation	findDefaultFulfillmentLocation() Returns the first default fulfillment location found.
FulfillmentLocation	save(FulfillmentLocation fulfillmentLocation) Persists the FulfillmentLocation
void	updateOtherDefaultLocationToFalse(FulfillmentLocation fulfillmentLocation) Updates all FulfillmentLocations in the database to false, excluding the FulfillmentLocation that was passed in

Method Detail

findAll

List<FulfillmentLocation> findAll()

Retrieves all of the fulfillment locations

Returns:

List of FulfillmentLocation

findById

FulfillmentLocation findById(Long fulfillmentLocationId)

Retrieves a FulfillmentLocation from the given id

Parameters:

fulfillmentLocationId -

Returns:

FulfillmentLocation

save

FulfillmentLocation save(FulfillmentLocation fulfillmentLocation)

Persists the FulfillmentLocation

Parameters:

fulfillmentLocation -

Returns:

the persisted FulfillmentLocation

delete

void delete(FulfillmentLocation fulfillmentLocation)

Deletes the passed FulfillmentLocation

Parameters:

fulfillmentLocation -

findDefaultFulfillmentLocation

FulfillmentLocation findDefaultFulfillmentLocation()

Returns the first default fulfillment location found. There should only be one default.

Returns:

findAllFulfillmentLocationsForSku

List<FulfillmentLocation> findAllFulfillmentLocationsForSku(Long skuId)

Returns all fulfillment locations associated with a Sku. This does not take into account any matching fulfillment types.

findAllFulfillmentLocationsForSku

List<FulfillmentLocation> findAllFulfillmentLocationsForSku(Long skuId,
                                                            @Nullable
                                                            org.broadleafcommerce.core.order.service.type.FulfillmentType fulfillmentType)

Returns all fulfillment locations associated with a sku for a particular fulfillment type. If fulfillmentType is null then it is ignored invokes findAllFulfillmentLocationsForSku(Long)

Parameters:

skuId -

fulfillmentType - (optional) the type of FulfillmentLocation to look for

Returns:

a list of FulfillmentLocations that can be found for the given Sku. If the given fulfillmentType is null or FulfillmentType.PHYSICAL_PICKUP_OR_SHIP then the resulting list could be fulfillment locations that have either FulfillmentType.PHYSICAL_PICKUP_OR_SHIP, FulfillmentType#SHIP or FulfillmentType.PHYSICAL_PICKUP

findAllFulfillmentLocationsForSku

List<FulfillmentLocation> findAllFulfillmentLocationsForSku(Long skuId,
                                                            @Nullable
                                                            org.broadleafcommerce.core.order.service.type.FulfillmentType fulfillmentType,
                                                            int minimumQuantity)

Returns all fulfillment locations associated with a sku for a particular fulfillment type and has at least enough inventory as quantity. If fulfillmentType is null then it is ignored

Parameters:

skuId - the Sku to look up

fulfillmentType - (optional) type of FulfillmentLocation to look for

quantity - filters the list of FulfillmentLocations by ones that have enough of this quantity

Returns:

a list of FulfillmentLocations that can be found for the given Sku. If the given fulfillmentType is null or FulfillmentType.PHYSICAL_PICKUP_OR_SHIP then the resulting list could be fulfillment locations that have either FulfillmentType.PHYSICAL_PICKUP_OR_SHIP, FulfillmentType#SHIP or FulfillmentType.PHYSICAL_PICKUP

findAllFulfillmentLocations

List<FulfillmentLocation> findAllFulfillmentLocations(org.broadleafcommerce.core.order.service.type.FulfillmentType fulfillmentType)

Gets all of the fulfillment locations for the specified fulfillment type. If the fulfillmentType is FulfillmentType.PHYSICAL_PICKUP_OR_SHIP then this will pick up both FulfillmentType.PHYSICAL_PICKUP as well as FulfillmentType.PHYSICAL_SHIP. If the given fulfillmentType is null, this is equivalent to invoking findAll()

Parameters:

fulfillmentType - the type of fulfillment location to find

Returns:

createNew

FulfillmentLocation createNew()

Creates a new instance of a FulfillmentLocation. Does not save it in the database.

Returns:

updateOtherDefaultLocationToFalse

void updateOtherDefaultLocationToFalse(FulfillmentLocation fulfillmentLocation)

Updates all FulfillmentLocations in the database to false, excluding the FulfillmentLocation that was passed in

Parameters:

fulfillmentLocation - the FulfillmentLocation that will essentially become the new default location