Package com.broadleafcommerce.inventory.domain

Class InventoryLocation

java.lang.Object
com.broadleafcommerce.inventory.domain.InventoryLocation
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable
public class InventoryLocation extends Object implements Serializable, com.broadleafcommerce.data.tracking.core.ContextStateAware
General business entity for defining an InventoryLocation, or physical location at which inventory is stored, contained, shipped from, or picked up at. Generally speaking, this represents a store, pickup location, warehouse, or all, and has a physical address, including latitude and longitude.
Author:
Kelly Tisdell (ktisdell)
See Also:

  • Constructor Details

    • InventoryLocation

      public InventoryLocation()

  • Method Details

    • getId

      public String getId()
      The InventoryLocation contextId.
      Returns:
      the contextId of this Inventory Location

    • getLocationNumber

      public String getLocationNumber()
      Arbitrary location number, which could be an external ID, store number, etc.
      Returns:
      the locationNumber

    • getName

      public String getName()
      Arbitrary name of the location.
      Returns:

    • isPickupLocation

      public boolean isPickupLocation()
      Indicates if this location is available for pickup. Default is false.
      Returns:

    • isShippingLocation

      public boolean isShippingLocation()
      Indicates if this location is available for shipping. Default is true.
      Returns:

    • 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:

    • getVendorRef

      public String 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 Address getAddress()
      Physical address of this location.
      Returns:

    • getContextState

      public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
      Specified by:
      getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware

    • setId

      public void setId(String id)
      The InventoryLocation contextId.
      Parameters:
      contextId -

    • setLocationNumber

      public void setLocationNumber(String locationNumber)
      Arbitrary location number, which could be an external ID, store number, etc.
      Parameters:
      locationNumber -

    • setName

      public void setName(String name)
      Arbitrary name of the location.
      Parameters:
      name -

    • setPickupLocation

      public void setPickupLocation(boolean pickupLocation)
      Indicates if this location is available for pickup. Default is false.
      Parameters:
      pickupLocation -

    • setShippingLocation

      public void setShippingLocation(boolean shippingLocation)
      Indicates if this location is available for shipping. Default is true.
      Parameters:
      shippingLocation -

    • 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 -

    • setVendorRef

      public void setVendorRef(String vendorRef)
      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(Address address)
      Physical address of this location.
      Parameters:
      address -

    • setContextState

      public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
      Specified by:
      setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object