Class SkuInventoryReservationRequestGroup
java.lang.Object
com.broadleafcommerce.cartoperation.domain.SkuInventoryReservationRequestGroup
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 Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
Indicates if this group is expected to be picked up or shipped.The locationId of the Inventory Location from which the customer wishes to receive inventory.List of items to reserve.com.broadleafcommerce.order.common.domain.Address
This is most useful when Fulfillment Type is SHIP.int
hashCode()
void
setFulfillmentType
(String fulfillmentType) Indicates if this group is expected to be picked up or shipped.void
setRequestedInventoryLocationId
(String requestedInventoryLocationId) The locationId of the Inventory Location from which the customer wishes to receive inventory.void
setRequestedItems
(List<SkuInventoryReservationRequestItem> requestedItems) List of items to reserve.void
setShipToAddress
(com.broadleafcommerce.order.common.domain.Address shipToAddress) This is most useful when Fulfillment Type is SHIP.toString()
-
Constructor Details
-
SkuInventoryReservationRequestGroup
public SkuInventoryReservationRequestGroup()
-
-
Method Details
-
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
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. -
getRequestedItems
List of items to reserve. This cannot be null and must contain at least 1 item. -
setFulfillmentType
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
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
List of items to reserve. This cannot be null and must contain at least 1 item.- Parameters:
requestedItems
-
-
toString
-
equals
-
canEqual
-
hashCode
public int hashCode()
-