Package com.broadleafcommerce.cartoperation.service.provider.external.domain.inventory

Class InventoryAvailabilityRequest

java.lang.Object
com.broadleafcommerce.cartoperation.service.provider.external.domain.inventory.InventoryAvailabilityRequest
All Implemented Interfaces:
Serializable
public class InventoryAvailabilityRequest extends Object implements Serializable
A request DTO to fetch the inventory availability status of a catalog item.
Author:
Marie Standeven (mariestandeven)
See Also:

  • Constructor Details

    • InventoryAvailabilityRequest

      public InventoryAvailabilityRequest()

  • Method Details

    • getSku

      public String getSku()
      This Stock Keeping Unit that uniquely identifies this item.

    • getReferenceNumber

      public String getReferenceNumber()
      The reference number used to identify any existing soft inventory reservations.

      Existing soft reservations are excluded if this field is passed in. For example, if a SKU has total of 2 available and 1 is reserved for userA, and userA checks inventory availability for a quantity of 2 for the same SKU. The existing soft reservation is excluded from the check in this case, effectively making this request to check for an additional quantity of 1 to be available. However, if userB sends the same request to check availability for a quantity of 2 for the same SKU, it would return unavailable since only 1 is available as the other one is reserved for userA.

    • getQuantity

      public int getQuantity()
      The quantity being requested for this item.

    • getAdditionalAttributes

      public Map<String,Object> getAdditionalAttributes()
      Map holding any additional attributes passed in the request not matching any defined properties.

    • setSku

      public void setSku(String sku)
      This Stock Keeping Unit that uniquely identifies this item.

    • setReferenceNumber

      public void setReferenceNumber(String referenceNumber)
      The reference number used to identify any existing soft inventory reservations.

      Existing soft reservations are excluded if this field is passed in. For example, if a SKU has total of 2 available and 1 is reserved for userA, and userA checks inventory availability for a quantity of 2 for the same SKU. The existing soft reservation is excluded from the check in this case, effectively making this request to check for an additional quantity of 1 to be available. However, if userB sends the same request to check availability for a quantity of 2 for the same SKU, it would return unavailable since only 1 is available as the other one is reserved for userA.

    • setQuantity

      public void setQuantity(int quantity)
      The quantity being requested for this item.

    • setAdditionalAttributes

      public void setAdditionalAttributes(Map<String,Object> additionalAttributes)
      Map holding any additional attributes passed in the request not matching any defined properties.

    • 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

    • toString

      public String toString()
      Overrides:
      toString in class Object