com.broadleafcommerce.inventory.advanced.domain

Interface FulfillmentLocation

All Superinterfaces:

Serializable

All Known Implementing Classes:

FulfillmentLocationImpl

public interface FulfillmentLocation
extends Serializable

Representative of a location that has inventory associated with it. While not explicitly exposed through getters, a FulfillmentLocation can contain a list of Inventory. This list of Inventory can be retrieved by using various methods found in InventoryService.

FulfillmentLocations are normally unique on a per-address basis. For instance, you might have a warehouse in the US that has some amount of inventory, and another warehouse in the UK that has different inventory.

.

Author:

Phillip Verheyden (phillipuniverse)

Method Summary

Modifier and Type	Method and Description
org.broadleafcommerce.profile.core.domain.Address	getAddress() Gets where this is physically located.
Boolean	getDefaultLocation() Retrieves if this fulfillment location as default
org.broadleafcommerce.core.order.service.type.FulfillmentType	getFulfillmentType() The type of fulfillment that this location supports.
Long	getId()
String	getName() Convenient name for this location for internal usage and to make the admin easier to navigate
boolean	isDefaultLocation() Retrieves if this fulfillment location as default.
void	setAddress(org.broadleafcommerce.profile.core.domain.Address address) Set the Address of the fulfillment location
void	setDefaultLocation(Boolean defaultLocation) Sets whether or not this fulfillment location is the default one
void	setFulfillmentType(org.broadleafcommerce.core.order.service.type.FulfillmentType fulfillmentType) Sets the type of fulfillment that this location supports.
void	setId(Long id)
void	setName(String name) For convenience you can name an inventory location.

Method Detail

getId

Long getId()

Returns:

the id of the fulfillment location

setId

void setId(Long id)

Parameters:

id - the id of the fulfillment location

getName

String getName()

Convenient name for this location for internal usage and to make the admin easier to navigate

Returns:

the name of this location

setName

void setName(String name)

For convenience you can name an inventory location.

Parameters:

name - the new name for this location

getAddress

org.broadleafcommerce.profile.core.domain.Address getAddress()

Gets where this is physically located. This could be used in record keeping as well as exotic scenarios where specific inventory should be used in one location and not another.

Returns:

the physical Address of the fulfillment location

setAddress

void setAddress(org.broadleafcommerce.profile.core.domain.Address address)

Set the Address of the fulfillment location

Parameters:

address -

getFulfillmentType

org.broadleafcommerce.core.order.service.type.FulfillmentType getFulfillmentType()

The type of fulfillment that this location supports. For physical inventory not all locations may support both FulfillmentType.PHYSICAL_PICKUP and FulfillmentType.PHYSICAL_SHIP.

Returns:

the type of fulfillment that is supported at this location

setFulfillmentType

void setFulfillmentType(org.broadleafcommerce.core.order.service.type.FulfillmentType fulfillmentType)

Sets the type of fulfillment that this location supports. This could potentially be used in conjunction with Sku.getFulfillmentType() to determine which location to decrement inventory from

Parameters:

fulfillmentType - the new FulfillmentType that this location supports

See Also:

InventoryLocationResolver#resolveInventoryLocationForDecrement(org.broadleafcommerce.core.order.domain.FulfillmentGroup, org.broadleafcommerce.core.catalog.domain.Sku, int)}

getDefaultLocation

Boolean getDefaultLocation()

Retrieves if this fulfillment location as default

Returns:

isDefaultLocation

boolean isDefaultLocation()

Retrieves if this fulfillment location as default.

Returns:

setDefaultLocation

void setDefaultLocation(Boolean defaultLocation)

Sets whether or not this fulfillment location is the default one

Parameters:

defaultLocation -