Package com.broadleafcommerce.cartoperation.domain

Class SkuInventoryReservationRequestGroup

  • public class SkuInventoryReservationRequestGroup
extends Object
    Component to allow us to group SkuInventoryReservationRequestItem instances together for Inventory reservation, based on the fulfillment type and either shipToAddress or requestedInventoryLocationId.
    Author:
    Kelly Tisdell (ktisdell)

    • Constructor Detail

      • SkuInventoryReservationRequestGroup

        public SkuInventoryReservationRequestGroup()

    • Method Detail

      • getFulfillmentType

        public String getFulfillmentType()
        Indicates if this group is expected to be picked up or shipped. For PICKUP, pickupLocationId is required. For SHIP, pickupLocationId is optional, but without it, shipToAddress is required.

      • getRequestedInventoryLocationId

        public String getRequestedInventoryLocationId()
        The locationId of the Inventory Location from which the customer wishes to receive inventory. This is more typically used for PICKUP. However, the calling application may know the Inventory Location ID from which a SHIP should occur. In this case, it's perfectly acceptable to provide this value in lieu of the shipToAddress.

      • getShipToAddress

        public com.broadleafcommerce.order.common.domain.Address getShipToAddress()
        This is most useful when Fulfillment Type is SHIP. It provides a hint to the system to attempt to select the best Inventory Location(s) for decrementing inventory for the purpose of shipping items. This is required if Fulfillment Type is SHIP and if requestedInventoryLocationId is blank.

      • setFulfillmentType

        public void setFulfillmentType​(String fulfillmentType)
        Indicates if this group is expected to be picked up or shipped. For PICKUP, pickupLocationId is required. For SHIP, pickupLocationId is optional, but without it, shipToAddress is required.

      • setRequestedInventoryLocationId

        public void setRequestedInventoryLocationId​(String requestedInventoryLocationId)
        The locationId of the Inventory Location from which the customer wishes to receive inventory. This is more typically used for PICKUP. However, the calling application may know the Inventory Location ID from which a SHIP should occur. In this case, it's perfectly acceptable to provide this value in lieu of the shipToAddress.

      • setShipToAddress

        public void setShipToAddress​(com.broadleafcommerce.order.common.domain.Address shipToAddress)
        This is most useful when Fulfillment Type is SHIP. It provides a hint to the system to attempt to select the best Inventory Location(s) for decrementing inventory for the purpose of shipping items. This is required if Fulfillment Type is SHIP and if requestedInventoryLocationId is blank.

      • setRequestedItems

        public void setRequestedItems​(List<SkuInventoryReservationRequestItem> requestedItems)
        List of items to reserve. This cannot be null and must contain at least 1 item.
        Parameters:
        requestedItems -

      • canEqual

        protected boolean canEqual​(Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object