Package com.broadleafcommerce.inventory.domain

Class SkuInventoryReservationRequest

java.lang.Object
com.broadleafcommerce.inventory.domain.SkuInventoryReservationRequest
All Implemented Interfaces:
Serializable
public class SkuInventoryReservationRequest extends Object implements Serializable
Container to allow serialization and transport of specific inventory reservation requests.
Author:
Kelly Tisdell (ktisdell)
See Also:

  • Constructor Details

    • SkuInventoryReservationRequest

      public SkuInventoryReservationRequest()

  • Method Details

    • getRequestId

      public String getRequestId()
      An external ID for a sku inventory reservation request that can be used to notify external systems of changes related to this request. By default, this is set to a cart or order ID.

    • getReservationRequestType

      public String getReservationRequestType()
      Indicates if the Inventory Reservation Request is a HARD or SOFT request. Soft requests are temporary and may be reversed if a HARD reservation is not eventually created. SOFT requests typically happen prior to payment or finalizing checkout. HARD requests are typically done after payment or finalizing checkout.

    • getSkuReferenceFieldType

      public String getSkuReferenceFieldType()
      Indicates how we should be looking up SkuInventory (by which field) with respect to skuReferenceValue. Default allowed values are:

      SKU_CODE (default)

      SKU_EXTERNAL_ID

      UPC

      EAN

      GTIN

    • getReservationRequestGroups

      public List<SkuInventoryReservationRequestGroup> getReservationRequestGroups()
      Logically separate groups into pickup or ship groups, along with items to be adjusted. Each SkuInventoryReservationRequestGroup is loosely correlated with a Fulfillment Group in the Cart domain.

    • setRequestId

      public void setRequestId(String requestId)
      An external ID for a sku inventory reservation request that can be used to notify external systems of changes related to this request. By default, this is set to a cart or order ID.

    • setReservationRequestType

      public void setReservationRequestType(String reservationRequestType)
      Indicates if the Inventory Reservation Request is a HARD or SOFT request. Soft requests are temporary and may be reversed if a HARD reservation is not eventually created. SOFT requests typically happen prior to payment or finalizing checkout. HARD requests are typically done after payment or finalizing checkout.

    • setSkuReferenceFieldType

      public void setSkuReferenceFieldType(String skuReferenceFieldType)
      Indicates how we should be looking up SkuInventory (by which field) with respect to skuReferenceValue. Default allowed values are:

      SKU_CODE (default)

      SKU_EXTERNAL_ID

      UPC

      EAN

      GTIN

    • setReservationRequestGroups

      public void setReservationRequestGroups(List<SkuInventoryReservationRequestGroup> reservationRequestGroups)
      Logically separate groups into pickup or ship groups, along with items to be adjusted. Each SkuInventoryReservationRequestGroup is loosely correlated with a Fulfillment Group in the Cart domain.

    • 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