Package org.broadleafcommerce.core.offer.service.discount.domain

Interface PromotableOrderItem

All Superinterfaces:
Serializable
All Known Implementing Classes:
PromotableOrderItemImpl
public interface PromotableOrderItem extends Serializable

  • Method Details

    • updateRuleVariables

      void updateRuleVariables(Map<String,Object> ruleVars)
      Adds the item to the rule variables map.
      Parameters:
      ruleVars -

    • resetPriceDetails

      void resetPriceDetails()
      Called by pricing engine to reset the state of this item.

    • isDiscountingAllowed

      boolean isDiscountingAllowed()
      Returns true if this item can receive item level discounts.
      Returns:

    • isOrderItemContainer

      boolean isOrderItemContainer()
      Returns true if this PromotableOrderItem contains other items

    • getOrderItemContainer

      OrderItemContainer getOrderItemContainer()
      Returns an OrderItemContainer for this OrderItem or null if this item is not an instance of OrderItemContainer.

    • getSalePriceBeforeAdjustments

      org.broadleafcommerce.common.money.Money getSalePriceBeforeAdjustments()
      Returns the salePrice without adjustments

    • getRetailPriceBeforeAdjustments

      org.broadleafcommerce.common.money.Money getRetailPriceBeforeAdjustments()
      Returns the retailPrice without adjustments

    • isOnSale

      boolean isOnSale()
      Returns true if the item has a sale price that is lower than the retail price.

    • getPromotableOrderItemPriceDetails

      List<PromotableOrderItemPriceDetail> getPromotableOrderItemPriceDetails()
      Returns the list of priceDetails associated with this item.
      Returns:

    • getPriceBeforeAdjustments

      org.broadleafcommerce.common.money.Money getPriceBeforeAdjustments(boolean applyToSalePrice)
      Return the salePriceBeforeAdjustments if the passed in param is true. Otherwise return the retailPriceBeforeAdjustments.
      Returns:

    • getCurrentBasePrice

      org.broadleafcommerce.common.money.Money getCurrentBasePrice()
      Returns the basePrice of the item (baseSalePrice or baseRetailPrice)
      Returns:

    • getQuantity

      int getQuantity()
      Returns the quantity for this orderItem
      Returns:

    • getCurrency

      org.broadleafcommerce.common.currency.domain.BroadleafCurrency getCurrency()
      Returns the currency of the related order.
      Returns:

    • removeAllItemAdjustments

      void removeAllItemAdjustments()
      Effectively deletes all priceDetails associated with this item and r

    • mergeLikeDetails

      void mergeLikeDetails()
      Merges any priceDetails that share the same adjustments.

    • getOrderItemId

      Long getOrderItemId()
      Returns the id of the contained OrderItem

    • calculateTotalAdjustmentValue

      org.broadleafcommerce.common.money.Money calculateTotalAdjustmentValue()
      Returns the value of all adjustments.

    • calculateTotalWithAdjustments

      org.broadleafcommerce.common.money.Money calculateTotalWithAdjustments()
      Returns the final total for this item taking into account the finalized adjustments. Intended to be called after the adjustments have been finalized.

    • calculateTotalWithoutAdjustments

      org.broadleafcommerce.common.money.Money calculateTotalWithoutAdjustments()
      Returns the total for this item if not adjustments applied.

    • createNewDetail

      PromotableOrderItemPriceDetail createNewDetail(int quantity)
      Creates a new detail with the associated quantity. Intended for use as part of the PriceDetail split.
      Parameters:
      quantity -
      Returns:

    • getOrderItem

      OrderItem getOrderItem()
      Returns the underlying orderItem. Manipulation of the underlying orderItem is not recommended. This method is intended for unit test and read only access although that is not strictly enforced.
      Returns:

    • getExtraDataMap

      Map<String,Object> getExtraDataMap()
      Map available to implementations to store data needed for custom logic.