com.broadleafcommerce.cartoperation.domain

Class SkuInventoryReservationRequestGroup

java.lang.Object

com.broadleafcommerce.cartoperation.domain.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 Summary

Constructors

Constructor and Description
SkuInventoryReservationRequestGroup()

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getFulfillmentType() Indicates if this group is expected to be picked up or shipped.
String	getRequestedInventoryLocationId() The locationId of the Inventory Location from which the customer wishes to receive inventory.
List<SkuInventoryReservationRequestItem>	getRequestedItems() List of items to reserve.
com.broadleafcommerce.order.common.domain.Address	getShipToAddress() 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.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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.

getRequestedItems

public List<SkuInventoryReservationRequestItem> getRequestedItems()

List of items to reserve. This cannot be null and must contain at least 1 item.

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 -

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