org.broadleafcommerce.core.order.domain
Interface OrderItemPriceDetail

All Superinterfaces:
Serializable
All Known Implementing Classes:
OrderItemPriceDetailImpl

public interface OrderItemPriceDetail
extends Serializable


Method Summary
 Money getAdjustmentValue()
          Returns the value of all adjustments for a single quantity of the item.
 Long getId()
          The unique identifier of this OrderItem
 OrderItem getOrderItem()
          Reference back to the containing orderItem.
 List<OrderItemPriceDetailAdjustment> getOrderItemPriceDetailAdjustments()
          Returns a List of the adjustments that effected this priceDetail.
 int getQuantity()
          The quantity of this OrderItemPriceDetail.
 Money getTotalAdjustedPrice()
          Returns the total adjustedPrice.
 Money getTotalAdjustmentValue()
          Returns getAdjustmentValue() * the quantity.
 boolean getUseSalePrice()
          Indicates that the adjustments were based off of the item's sale price.
 void setId(Long id)
          Sets the unique id of the OrderItem.
 void setOrderItem(OrderItem order)
          Sets the orderItem for this itemPriceDetail.
 void setOrderItemAdjustments(List<OrderItemPriceDetailAdjustment> orderItemPriceDetailAdjustments)
          Sets the list of OrderItemPriceDetailAdjustment
 void setQuantity(int quantity)
          Returns the quantity
 void setUseSalePrice(boolean useSalePrice)
          Set that the adjustments should be taken off of the item's sale price.
 

Method Detail

getId

Long getId()
The unique identifier of this OrderItem

Returns:

setId

void setId(Long id)
Sets the unique id of the OrderItem. Typically left blank for new items and Broadleaf will set using the next sequence number.

Parameters:
id -

getOrderItem

OrderItem getOrderItem()
Reference back to the containing orderItem.

Returns:

setOrderItem

void setOrderItem(OrderItem order)
Sets the orderItem for this itemPriceDetail.

Parameters:
order -

getOrderItemPriceDetailAdjustments

List<OrderItemPriceDetailAdjustment> getOrderItemPriceDetailAdjustments()
Returns a List of the adjustments that effected this priceDetail.

Returns:
a List of OrderItemPriceDetailAdjustment

setOrderItemAdjustments

void setOrderItemAdjustments(List<OrderItemPriceDetailAdjustment> orderItemPriceDetailAdjustments)
Sets the list of OrderItemPriceDetailAdjustment

Parameters:
orderItemPriceDetailAdjustments -

getQuantity

int getQuantity()
The quantity of this OrderItemPriceDetail.

Returns:

setQuantity

void setQuantity(int quantity)
Returns the quantity

Parameters:
quantity -

getAdjustmentValue

Money getAdjustmentValue()
Returns the value of all adjustments for a single quantity of the item. Use getTotalAdjustmentValue() to get the total for all quantities of this item.

Returns:

getTotalAdjustmentValue

Money getTotalAdjustmentValue()
Returns getAdjustmentValue() * the quantity.

Returns:

getTotalAdjustedPrice

Money getTotalAdjustedPrice()
Returns the total adjustedPrice.

Returns:

getUseSalePrice

boolean getUseSalePrice()
Indicates that the adjustments were based off of the item's sale price.

Returns:

setUseSalePrice

void setUseSalePrice(boolean useSalePrice)
Set that the adjustments should be taken off of the item's sale price.

Parameters:
useSalePrice -


Copyright © 2013. All Rights Reserved.