Package org.broadleafcommerce.core.order.service.call

Class OrderItemRequestDTO

java.lang.Object

org.broadleafcommerce.core.order.service.call.OrderItemRequestDTO

Direct Known Subclasses:

AddToCartItem, NonDiscreteOrderItemRequestDTO

public class OrderItemRequestDTO
extends Object

Only the product and quantity are required to add an item to an order.

The category can be inferred from the product's default category.

The sku can be inferred from either the passed in attributes as they are compared to the product's options or the sku can be determined from the product's default sku.

When adding a bundle using this DTO, you MUST have the ProductBundle included in the productId for it to properly instantiate the BundleOrderItem

Important Note: To protect against misuse, the OrderService's addItemToCart method will blank out any values passed in on this DTO for the overrideSalePrice or overrideRetailPrice.

Instead, implementors should call the more explicit addItemWithPriceOverrides.

Constructor Summary

Constructors

Constructor	Description
OrderItemRequestDTO()
OrderItemRequestDTO(Long productId, Integer quantity)
OrderItemRequestDTO(Long productId, Long skuId, Integer quantity)
OrderItemRequestDTO(Long productId, Long skuId, Long categoryId, Integer quantity)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getAdditionalAttributes()
Long	getCategoryId()
List<OrderItemRequestDTO>	getChildOrderItems()
Boolean	getHasConfigurationError()
Map<String,String>	getItemAttributes()
Long	getOrderItemId()
Money	getOverrideRetailPrice()
Money	getOverrideSalePrice()
Long	getParentOrderItemId()
Long	getProductId()
Integer	getQuantity()
Long	getSkuId()
void	setAdditionalAttributes(Map<String,String> additionalAttributes)
OrderItemRequestDTO	setCategoryId(Long categoryId)
void	setChildOrderItems(List<OrderItemRequestDTO> childOrderItems)
void	setHasConfigurationError(Boolean hasConfigurationError)
OrderItemRequestDTO	setItemAttributes(Map<String,String> itemAttributes)
OrderItemRequestDTO	setOrderItemId(Long orderItemId)
void	setOverrideRetailPrice(Money overrideRetailPrice)
void	setOverrideSalePrice(Money overrideSalePrice)
void	setParentOrderItemId(Long parentOrderItemId)
OrderItemRequestDTO	setProductId(Long productId)
OrderItemRequestDTO	setQuantity(Integer quantity)
OrderItemRequestDTO	setSkuId(Long skuId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OrderItemRequestDTO

public OrderItemRequestDTO()

OrderItemRequestDTO

public OrderItemRequestDTO(Long productId,
 Integer quantity)

OrderItemRequestDTO

public OrderItemRequestDTO(Long productId,
 Long skuId,
 Integer quantity)

OrderItemRequestDTO

public OrderItemRequestDTO(Long productId,
 Long skuId,
 Long categoryId,
 Integer quantity)

Method Details

getSkuId

public Long getSkuId()

setSkuId

public OrderItemRequestDTO setSkuId(Long skuId)

getCategoryId

public Long getCategoryId()

setCategoryId

public OrderItemRequestDTO setCategoryId(Long categoryId)

getProductId

public Long getProductId()

setProductId

public OrderItemRequestDTO setProductId(Long productId)

getQuantity

public Integer getQuantity()

setQuantity

public OrderItemRequestDTO setQuantity(Integer quantity)

getItemAttributes

public Map<String,String> getItemAttributes()

setItemAttributes

public OrderItemRequestDTO setItemAttributes(Map<String,String> itemAttributes)

getOrderItemId

public Long getOrderItemId()

setOrderItemId

public OrderItemRequestDTO setOrderItemId(Long orderItemId)

getOverrideSalePrice

public Money getOverrideSalePrice()

setOverrideSalePrice

public void setOverrideSalePrice(Money overrideSalePrice)

getOverrideRetailPrice

public Money getOverrideRetailPrice()

setOverrideRetailPrice

public void setOverrideRetailPrice(Money overrideRetailPrice)

getChildOrderItems

public List<OrderItemRequestDTO> getChildOrderItems()

setChildOrderItems

public void setChildOrderItems(List<OrderItemRequestDTO> childOrderItems)

getParentOrderItemId

public Long getParentOrderItemId()

setParentOrderItemId

public void setParentOrderItemId(Long parentOrderItemId)

getAdditionalAttributes

public Map<String,String> getAdditionalAttributes()

setAdditionalAttributes

public void setAdditionalAttributes(Map<String,String> additionalAttributes)

getHasConfigurationError

public Boolean getHasConfigurationError()

setHasConfigurationError

public void setHasConfigurationError(Boolean hasConfigurationError)