Package com.broadleafcommerce.inventory.domain

Class ConsolidatedInventoryAvailability

java.lang.Object
com.broadleafcommerce.inventory.domain.ConsolidatedInventoryAvailability
All Implemented Interfaces:
Serializable
public class ConsolidatedInventoryAvailability extends Object implements Serializable
Component that indicates that a SKU inventory is available for a particular tenant and/or application. The combination of tenantId and skuReference, or tenantId, applicationId, and skuReference implies that there is inventory available. What is "available" is defined by what was requested (e.g. pickup, ship to home, or in store). This is not meant to provide specific availability (e.g. quantity available, in which inventory location something is available, etc.). Generally, this will be used by more aggregate services to determine general inventory availability for a SKU within an application or tenant context. For example, Search Services may wish to filter out search results that do not have inventory available across a tenant or application.
Author:
Kelly Tisdell (ktisdell)
See Also:

  • Constructor Details

    • ConsolidatedInventoryAvailability

      public ConsolidatedInventoryAvailability()

  • Method Details

    • getTenantId

      public String getTenantId()
      The tenant ID to which this inventory availability belongs.
      Returns:
      the tenant ID

    • getApplicationId

      public String getApplicationId()
      The application ID to which this inventory availability belongs. This may be null if the inventory belongs to the tenant, and not an application.
      Returns:
      the tenant ID (nullable)

    • getSkuCode

      public String getSkuCode()
      The SKU code.
      Returns:
      the SKU reference

    • isAvailable

      public boolean isAvailable()
      Indicates if this inventory is available or not. Availability will be based on what is requested (e.g. for shipment, for pickup, in store, or a combination of 2 or more).
      Returns:
      whether this SKU is available or not

    • setTenantId

      public void setTenantId(String tenantId)
      The tenant ID to which this inventory availability belongs.
      Parameters:
      tenantId - the tenant ID

    • setApplicationId

      public void setApplicationId(String applicationId)
      The application ID to which this inventory availability belongs. This may be null if the inventory belongs to the tenant, and not an application.
      Parameters:
      applicationId - the application ID (nullable)

    • setSkuCode

      public void setSkuCode(String skuCode)
      The SKU code.
      Parameters:
      skuCode - the SKU or SKU code

    • setAvailable

      public void setAvailable(boolean available)
      Indicates if this inventory is available or not. Availability will be based on what is requested (e.g. for shipment, for pickup, in store, or a combination of 2 or more).
      Parameters:
      available - whether this SKU is available or not

    • 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