Class InventoryLocation
java.lang.Object
com.broadleafcommerce.cartoperation.domain.InventoryLocation
- All Implemented Interfaces:
Serializable
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
com.broadleafcommerce.fulfillment.common.domain.Address
Physical address of this location.getId()
TheInventoryLocation
contextId.Arbitrary location number, which could be an external ID, store number, etc.getName()
Arbitrary name of the location.Soft reference to the vendor associated with this inventory location.int
hashCode()
boolean
Indicates if this location is available for pickup.boolean
Indicates if this location is available for shipping.boolean
Indicates if this inventory location is also a store, meaning that it is a location that customers can come to shop.void
setAddress
(com.broadleafcommerce.fulfillment.common.domain.Address address) Physical address of this location.void
TheInventoryLocation
contextId.void
setLocationNumber
(String locationNumber) Arbitrary location number, which could be an external ID, store number, etc.void
Arbitrary name of the location.void
setPickupLocation
(boolean pickupLocation) Indicates if this location is available for pickup.void
setShippingLocation
(boolean shippingLocation) Indicates if this location is available for shipping.void
setStoreLocation
(boolean storeLocation) Indicates if this inventory location is also a store, meaning that it is a location that customers can come to shop.void
setVendorRef
(String vendorRef) Soft reference to the vendor associated with this inventory location.toString()
-
Constructor Details
-
InventoryLocation
public InventoryLocation()
-
-
Method Details
-
getId
TheInventoryLocation
contextId.- Returns:
- the contextId of this Inventory Location
-
getLocationNumber
Arbitrary location number, which could be an external ID, store number, etc.- Returns:
- the locationNumber
-
getName
Arbitrary name of the location.- Returns:
- The name of the location.
-
isPickupLocation
public boolean isPickupLocation()Indicates if this location is available for pickup. Default is false.- Returns:
- True if this location is available for pickup.
-
isShippingLocation
public boolean isShippingLocation()Indicates if this location is available for shipping. Default is true.- Returns:
- True if this location is available for shipping.
-
isStoreLocation
public boolean isStoreLocation()Indicates if this inventory location is also a store, meaning that it is a location that customers can come to shop. Default is false.- Returns:
- True if this inventory location is also a physical store.
-
getVendorRef
Soft reference to the vendor associated with this inventory location. This value can be null, in which case, no vendor is associated.- Returns:
- Soft reference to the vendor associated with this location.
-
getAddress
public com.broadleafcommerce.fulfillment.common.domain.Address getAddress()Physical address of this location.- Returns:
- The physical address of this location.
-
setId
TheInventoryLocation
contextId.- Parameters:
contextId
-
-
setLocationNumber
Arbitrary location number, which could be an external ID, store number, etc.- Parameters:
locationNumber
-
-
setName
Arbitrary name of the location.- Parameters:
name
- The name of the location.
-
setPickupLocation
public void setPickupLocation(boolean pickupLocation) Indicates if this location is available for pickup. Default is false.- Parameters:
pickupLocation
- True if this location is available for pickup.
-
setShippingLocation
public void setShippingLocation(boolean shippingLocation) Indicates if this location is available for shipping. Default is true.- Parameters:
shippingLocation
- True if this location is available for shipping.
-
setStoreLocation
public void setStoreLocation(boolean storeLocation) Indicates if this inventory location is also a store, meaning that it is a location that customers can come to shop. Default is false.- Parameters:
storeLocation
- True if this inventory location is also a physical store.
-
setVendorRef
Soft reference to the vendor associated with this inventory location. This value can be null, in which case, no vendor is associated.- Parameters:
vendorRef
- Soft reference to the vendor associated with this location.
-
setAddress
public void setAddress(com.broadleafcommerce.fulfillment.common.domain.Address address) Physical address of this location.- Parameters:
address
- The physical address of this location.
-
toString
-
equals
-
canEqual
-
hashCode
public int hashCode()
-