Interface OrderItemPriceDetail
- All Superinterfaces:
MultiTenantCloneable<OrderItemPriceDetail>,Serializable
- All Known Implementing Classes:
OrderItemPriceDetailImpl
public interface OrderItemPriceDetail
extends Serializable, MultiTenantCloneable<OrderItemPriceDetail>
-
Method Summary
Modifier and TypeMethodDescriptionReturns the value of all adjustments for a single quantity of the item.Returns the value of future credit adjustments for a single quantity of the item.Returns a List of the future credit adjustments that effected this priceDetail.Returns getFutureCreditAdjustmentValue() * the quantity.getId()The unique identifier of this OrderItemReference back to the containing orderItem.Returns a List of the adjustments that effected this priceDetail.intThe quantity of thisOrderItemPriceDetail.Returns the total adjustedPrice.Returns getAdjustmentValue() * the quantity.booleanIndicates that the adjustments were based off of the item's sale price.voidSets the unique id of the OrderItem.voidsetOrderItem(OrderItem order) Sets the orderItem for this itemPriceDetail.voidsetOrderItemAdjustments(List<OrderItemPriceDetailAdjustment> orderItemPriceDetailAdjustments) Sets the list of OrderItemPriceDetailAdjustmentvoidsetQuantity(int quantity) Returns the quantityvoidsetUseSalePrice(boolean useSalePrice) Set that the adjustments should be taken off of the item's sale price.Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable
createOrRetrieveCopyInstance
-
Method Details
-
getId
Long getId()The unique identifier of this OrderItem- Returns:
-
setId
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
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
-
getFutureCreditOrderItemPriceDetailAdjustments
List<OrderItemPriceDetailAdjustment> getFutureCreditOrderItemPriceDetailAdjustments()Returns a List of the future credit adjustments that effected this priceDetail.See
Offer.getAdjustmentType()for more info on future credit- Returns:
- a List of OrderItemPriceDetailAdjustment
-
setOrderItemAdjustments
Sets the list of OrderItemPriceDetailAdjustment- Parameters:
orderItemPriceDetailAdjustments-
-
getQuantity
int getQuantity()The quantity of thisOrderItemPriceDetail.- 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:
-
getFutureCreditAdjustmentValue
Money getFutureCreditAdjustmentValue()Returns the value of future credit adjustments for a single quantity of the item.Use
getFutureCreditTotalAdjustmentValue()to get the total for all quantities of this item.See
Offer.getAdjustmentType()for more info on future credit- Returns:
-
getTotalAdjustmentValue
Money getTotalAdjustmentValue()Returns getAdjustmentValue() * the quantity.- Returns:
-
getFutureCreditTotalAdjustmentValue
Money getFutureCreditTotalAdjustmentValue()Returns getFutureCreditAdjustmentValue() * the quantity.See
Offer.getAdjustmentType()for more info on future credit- 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-
-