Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Fields
• Deprecated Methods

Deprecated Interfaces

Interface and Description
org.broadleafcommerce.core.inventory.dao.AvailabilityDao This is no longer required and is instead implemented as a third-party inventory module
org.broadleafcommerce.core.inventory.service.AvailabilityService This is no longer required and is instead implemented as a third-party inventory module
org.broadleafcommerce.core.util.domain.CodeType
org.broadleafcommerce.core.util.service.CodeTypeService
org.broadleafcommerce.core.order.service.legacy.LegacyCartService
org.broadleafcommerce.core.order.service.legacy.LegacyOrderService
org.broadleafcommerce.core.search.domain.SearchIntercept Replaced in functionality by SearchRedirect
org.broadleafcommerce.core.search.dao.SearchInterceptDao Replaced in functionality by SearchRedirectDao
org.broadleafcommerce.core.pricing.service.module.ShippingModule Superceded by functionality given by FulfillmentOption and FulfillmentPricingProvider
org.broadleafcommerce.core.pricing.domain.ShippingRate
org.broadleafcommerce.core.pricing.dao.ShippingRateDao Superceded in functionality by BandedPriceFulfillmentOption and BandedFulfillmentPricingProvider
org.broadleafcommerce.core.pricing.service.ShippingRateService Superceded in functionality by BandedPriceFulfillmentOption and BandedFulfillmentPricingProvider
org.broadleafcommerce.core.pricing.service.ShippingService Should use the FulfillmentOption paradigm, implemented in FulfillmentPricingService
org.broadleafcommerce.core.inventory.domain.SkuAvailability This is no longer required and is instead implemented as a third-party inventory module
org.broadleafcommerce.core.pricing.service.module.TaxModule

Deprecated Classes

Class and Description
org.broadleafcommerce.core.inventory.dao.AvailabilityDaoImpl This is no longer required and is instead implemented as a third-party inventory module
org.broadleafcommerce.core.inventory.service.AvailabilityServiceImpl This is no longer required and is instead implemented as a third-party inventory module
org.broadleafcommerce.core.inventory.service.type.AvailabilityStatusType This is no longer required and is instead implemented as a third-party inventory module
org.broadleafcommerce.core.pricing.service.module.BandedShippingModule Superceded by functionality given by BandedPriceFulfillmentOption and BandedFulfillmentPricingProvider
org.broadleafcommerce.core.util.domain.CodeTypeImpl
org.broadleafcommerce.core.util.service.CodeTypeServiceImpl
org.broadleafcommerce.core.order.service.legacy.LegacyCartServiceImpl
org.broadleafcommerce.core.order.service.legacy.LegacyMergeCartServiceImpl
org.broadleafcommerce.core.order.service.legacy.LegacyOrderServiceImpl
org.broadleafcommerce.core.search.dao.SearchInterceptDaoImpl Replaced in functionality by SearchRedirectDaoImpl
org.broadleafcommerce.core.search.domain.SearchInterceptImpl Replaced in functionality by SearchRedirectImpl
org.broadleafcommerce.core.pricing.service.workflow.ShippingActivity Should use the FulfillmentOption paradigm, implemented in FulfillmentPricingService. This activity was replaced by FulfillmentGroupPricingActivity.
org.broadleafcommerce.core.pricing.dao.ShippingRateDaoImpl Superceded in functionality by BandedPriceFulfillmentOption and BandedFulfillmentPricingProvider
org.broadleafcommerce.core.pricing.domain.ShippingRateImpl
org.broadleafcommerce.core.pricing.service.ShippingRateServiceImpl Superceded in functionality by BandedPriceFulfillmentOption and BandedFulfillmentPricingProvider
org.broadleafcommerce.core.pricing.service.ShippingServiceImpl Should use the FulfillmentOption paradigm, implemented in FulfillmentPricingService
org.broadleafcommerce.core.pricing.service.workflow.type.ShippingServiceType Should use the FulfillmentOption and FulfillmentPricingProvider paradigm
org.broadleafcommerce.core.pricing.service.module.SimpleTaxModule
org.broadleafcommerce.core.inventory.domain.SkuAvailabilityImpl This is no longer required and is instead implemented as a third-party inventory module

Deprecated Fields

Field and Description
org.broadleafcommerce.core.order.domain.DiscreteOrderItemImpl.additionalAttributes
org.broadleafcommerce.core.offer.domain.OfferImpl.appliesToCustomerRules
org.broadleafcommerce.core.offer.domain.OfferImpl.appliesToOrderRules
org.broadleafcommerce.core.offer.domain.OfferImpl.applyDiscountToMarkedItems
org.broadleafcommerce.core.catalog.domain.CategoryImpl.categoryImages
org.broadleafcommerce.core.catalog.domain.CategoryImpl.childCategoryURLMap
org.broadleafcommerce.core.order.service.call.FulfillmentGroupRequest.method
org.broadleafcommerce.core.order.domain.FulfillmentGroupImpl.method
org.broadleafcommerce.core.order.service.call.FulfillmentGroupRequest.service
org.broadleafcommerce.core.order.domain.FulfillmentGroupImpl.service
org.broadleafcommerce.core.order.service.type.FulfillmentGroupStatusType.SHIPPED
org.broadleafcommerce.core.order.service.type.FulfillmentType.SHIPPING
org.broadleafcommerce.core.offer.domain.OfferImpl.uses
org.broadleafcommerce.core.offer.domain.OfferCodeImpl.uses

Deprecated Methods

Method and Description
org.broadleafcommerce.core.order.domain.Order.addAddedOfferCode(OfferCode)
org.broadleafcommerce.core.order.domain.OrderImpl.addAddedOfferCode(OfferCode)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderServiceImpl.addDiscreteItemToOrder(Order, DiscreteOrderItemRequest)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderService.addDiscreteItemToOrder(Order, DiscreteOrderItemRequest) Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderServiceImpl.addDiscreteItemToOrder(Order, DiscreteOrderItemRequest, boolean)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderService.addDiscreteItemToOrder(Order, DiscreteOrderItemRequest, boolean) Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder) Due to cart merging and gathering requirements, the item returned is not an actual cart item. NOTE: this will automatically associate the given order to the given itemRequest such that the resulting OrderItem will already have the Order associated to it
org.broadleafcommerce.core.order.service.legacy.LegacyOrderServiceImpl.addDynamicPriceDiscreteItemToOrder(Order, DiscreteOrderItemRequest, HashMap)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderService.addDynamicPriceDiscreteItemToOrder(Order, DiscreteOrderItemRequest, HashMap) Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderServiceImpl.addDynamicPriceDiscreteItemToOrder(Order, DiscreteOrderItemRequest, HashMap, boolean)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderService.addDynamicPriceDiscreteItemToOrder(Order, DiscreteOrderItemRequest, HashMap, boolean) Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderServiceImpl.addOrderItemToOrder(Order, OrderItem)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderService.addOrderItemToOrder(Order, OrderItem) Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderServiceImpl.addOrderItemToOrder(Order, OrderItem, boolean)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderService.addOrderItemToOrder(Order, OrderItem, boolean) Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderServiceImpl.addSkuToOrder(Long, Long, Long, Long, Integer)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderService.addSkuToOrder(Long, Long, Long, Long, Integer) Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderServiceImpl.addSkuToOrder(Long, Long, Long, Long, Integer, boolean)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderService.addSkuToOrder(Long, Long, Long, Long, Integer, boolean) Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderServiceImpl.addSkuToOrder(Long, Long, Long, Long, Integer, boolean, Map<String, String>)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderService.addSkuToOrder(Long, Long, Long, Long, Integer, boolean, Map<String, String>) Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderServiceImpl.addSkuToOrder(Long, Long, Long, Long, Integer, Map<String, String>)
org.broadleafcommerce.core.order.service.legacy.LegacyOrderService.addSkuToOrder(Long, Long, Long, Long, Integer, Map<String, String>) Call addItemToOrder(Long orderId, OrderItemRequestDTO orderItemRequestDTO, boolean priceOrder)
org.broadleafcommerce.core.catalog.service.CatalogServiceImpl.findCategoryByName(String)
org.broadleafcommerce.core.catalog.service.CatalogService.findCategoryByName(String)
org.broadleafcommerce.core.catalog.domain.Category.getActiveProducts() Use getActiveProductXrefs() instead.
org.broadleafcommerce.core.catalog.domain.CategoryImpl.getActiveProducts()
org.broadleafcommerce.core.order.domain.DiscreteOrderItem.getAdditionalAttributes() use getOrderItemAttributes instead
org.broadleafcommerce.core.order.domain.OrderItem.getAdjustmentValue() Delegates to OrderItem.getAverageAdjustmentValue() instead but this method is of little or no value in most practical applications unless only simple promotions are being used.
org.broadleafcommerce.core.catalog.domain.Category.getAllChildCategories() use getAllChildCategoryXrefs() instead.
org.broadleafcommerce.core.catalog.domain.CategoryImpl.getAllChildCategories()
org.broadleafcommerce.core.catalog.domain.ProductImpl.getAllParentCategories()
org.broadleafcommerce.core.catalog.domain.Category.getAllParentCategories() Use getAllParentCategoryXrefs() instead.
org.broadleafcommerce.core.catalog.domain.CategoryImpl.getAllParentCategories()
org.broadleafcommerce.core.catalog.domain.Product.getAllParentCategories() Use getAllParentCategoryXrefs() instead.
org.broadleafcommerce.core.catalog.domain.Category.getAllProducts() Use getAllProductXrefs() instead.
org.broadleafcommerce.core.catalog.domain.CategoryImpl.getAllProducts()
org.broadleafcommerce.core.payment.domain.PaymentResponseItemImpl.getAmountPaid()
org.broadleafcommerce.core.payment.domain.PaymentResponseItem.getAmountPaid()
org.broadleafcommerce.core.offer.domain.OfferImpl.getAppliesToCustomerRules()
org.broadleafcommerce.core.offer.domain.Offer.getAppliesToCustomerRules()
org.broadleafcommerce.core.offer.domain.OfferImpl.getAppliesToOrderRules()
org.broadleafcommerce.core.offer.domain.Offer.getAppliesToOrderRules()
org.broadleafcommerce.core.offer.domain.OfferImpl.getApplyDiscountToMarkedItems()
org.broadleafcommerce.core.catalog.domain.Category.getCategoryImage(String) replaced by Category.getCategoryMedia()
org.broadleafcommerce.core.catalog.domain.CategoryImpl.getCategoryImage(String)
org.broadleafcommerce.core.catalog.domain.Category.getCategoryImages() replaced by Category.getCategoryMedia()
org.broadleafcommerce.core.catalog.domain.CategoryImpl.getCategoryImages()
org.broadleafcommerce.core.catalog.domain.Category.getChildCategories() Use getChildCategoryXrefs() instead.
org.broadleafcommerce.core.catalog.domain.CategoryImpl.getChildCategories()
org.broadleafcommerce.core.catalog.domain.Category.getChildCategoryURLMap() This approach is inherently inefficient and should no longer be used
org.broadleafcommerce.core.catalog.domain.CategoryImpl.getChildCategoryURLMap()
org.broadleafcommerce.core.catalog.service.CatalogServiceImpl.getChildCategoryURLMapByCategoryId(Long)
org.broadleafcommerce.core.catalog.service.CatalogService.getChildCategoryURLMapByCategoryId(Long) this approach is inherently inefficient - don't use.
org.broadleafcommerce.core.offer.domain.OfferImpl.getCombinableWithOtherOffers()
org.broadleafcommerce.core.offer.domain.OfferImpl.getDeliveryType()
org.broadleafcommerce.core.offer.domain.Offer.getDeliveryType() Replaced by isAutomaticallyApplied property. In prior versions of Broadleaf deliveryType was used to differentiate "automatic" orders from those requiring a code. If the underlying property is null, this method will return a delivery type based on the isAutomatic property.
org.broadleafcommerce.core.pricing.service.module.SimpleTaxModule.getFactor()
org.broadleafcommerce.core.catalog.domain.Sku.getListPrice()
org.broadleafcommerce.core.order.service.call.FulfillmentGroupRequest.getMethod()
org.broadleafcommerce.core.order.domain.FulfillmentGroupImpl.getMethod()
org.broadleafcommerce.core.order.domain.FulfillmentGroup.getMethod() Should use FulfillmentGroup.getFulfillmentOption() instead
org.broadleafcommerce.core.payment.service.PaymentContextImpl.getOriginalPaymentAmount()
org.broadleafcommerce.core.payment.service.PaymentContext.getOriginalPaymentAmount()
org.broadleafcommerce.core.order.domain.OrderItem.getPrice() Delegates to OrderItem.getAveragePrice()
org.broadleafcommerce.core.order.domain.FulfillmentGroupItem.getPrice() Use FulfillmentGroupItem.getTotalItemAmount() or FulfillmentGroupItem.getTotalItemTaxableAmount()
org.broadleafcommerce.core.payment.service.PaymentContextImpl.getRemainingPaymentAmount()
org.broadleafcommerce.core.payment.service.PaymentContext.getRemainingPaymentAmount()
org.broadleafcommerce.core.order.domain.FulfillmentGroup.getRetailShippingPrice() - use FulfillmentGroup.getRetailFulfillmentPrice() instead. Deprecated as the price might be for other fulfillment types such as PickUpAtStore fees or download fees.
org.broadleafcommerce.core.order.domain.FulfillmentGroup.getSaleShippingPrice() - use FulfillmentGroup.getSaleFulfillmentPrice() instead.
org.broadleafcommerce.core.catalog.domain.CategoryAttribute.getSearchable() in favor of Field configuration since 2.0
org.broadleafcommerce.core.order.service.call.FulfillmentGroupRequest.getService()
org.broadleafcommerce.core.order.domain.FulfillmentGroupImpl.getService()
org.broadleafcommerce.core.order.domain.FulfillmentGroup.getService() Should use FulfillmentGroup.getFulfillmentOption() instead
org.broadleafcommerce.core.order.domain.FulfillmentGroup.getShippingPrice() - use FulfillmentGroup.getFulfillmentPrice() instead.
org.broadleafcommerce.core.offer.domain.OfferImpl.getStackable()
org.broadleafcommerce.core.order.domain.OrderItem.getTaxablePrice() If the item is taxable, returns OrderItem.getAveragePrice() It is recommended instead that tax calculation engines use the #getTotalTaxableAmount() which provides the taxable total for all quantities of this item. This method suffers from penny rounding errors in some situations.
org.broadleafcommerce.core.offer.domain.OfferImpl.getUses()
org.broadleafcommerce.core.offer.domain.OfferCodeImpl.getUses()
org.broadleafcommerce.core.offer.domain.OfferCode.getUses()
org.broadleafcommerce.core.offer.domain.Offer.getUses()
org.broadleafcommerce.core.offer.domain.OfferImpl.isApplyDiscountToMarkedItems()
org.broadleafcommerce.core.offer.domain.Offer.isApplyDiscountToMarkedItems()
org.broadleafcommerce.core.catalog.domain.SkuImpl.isMachineSortable()
org.broadleafcommerce.core.catalog.domain.Sku.isMachineSortable() use Sku.getIsMachineSortable() instead since that is the correct bean notation
org.broadleafcommerce.core.offer.domain.Offer.isStackable() Use isCombinable instead.
org.broadleafcommerce.core.catalog.dao.CategoryDaoImpl.readCategoryByName(String)
org.broadleafcommerce.core.catalog.dao.CategoryDao.readCategoryByName(String)
org.broadleafcommerce.core.order.domain.DiscreteOrderItem.setAdditionalAttributes(Map<String, String>) use setOrderItemAttributes instead
org.broadleafcommerce.core.catalog.domain.Category.setAllChildCategories(List<Category>) Use setAllChildCategoryXrefs() instead.
org.broadleafcommerce.core.catalog.domain.CategoryImpl.setAllChildCategories(List<Category>)
org.broadleafcommerce.core.catalog.domain.ProductImpl.setAllParentCategories(List<Category>)
org.broadleafcommerce.core.catalog.domain.Category.setAllParentCategories(List<Category>) Use setAllParentCategoryXrefs() instead.
org.broadleafcommerce.core.catalog.domain.CategoryImpl.setAllParentCategories(List<Category>)
org.broadleafcommerce.core.catalog.domain.Product.setAllParentCategories(List<Category>) Use setAllParentCategoryXrefs() instead.
org.broadleafcommerce.core.catalog.domain.Category.setAllProducts(List<Product>) Use setAllProductXrefs() instead.
org.broadleafcommerce.core.catalog.domain.CategoryImpl.setAllProducts(List<Product>)
org.broadleafcommerce.core.payment.domain.PaymentResponseItemImpl.setAmountPaid(Money)
org.broadleafcommerce.core.payment.domain.PaymentResponseItem.setAmountPaid(Money) setTransactionAmount() instead.
org.broadleafcommerce.core.offer.domain.OfferImpl.setAppliesToCustomerRules(String)
org.broadleafcommerce.core.offer.domain.Offer.setAppliesToCustomerRules(String)
org.broadleafcommerce.core.offer.domain.OfferImpl.setAppliesToOrderRules(String)
org.broadleafcommerce.core.offer.domain.Offer.setAppliesToOrderRules(String)
org.broadleafcommerce.core.offer.domain.OfferImpl.setApplyDiscountToMarkedItems(boolean)
org.broadleafcommerce.core.offer.domain.Offer.setApplyDiscountToMarkedItems(boolean)
org.broadleafcommerce.core.catalog.domain.Category.setCategoryImages(Map<String, String>) replaced by Category.setCategoryMedia(java.util.Map)
org.broadleafcommerce.core.catalog.domain.CategoryImpl.setCategoryImages(Map<String, String>)
org.broadleafcommerce.core.catalog.domain.Category.setChildCategories(List<Category>) Use setChildCategoryXrefs() instead.
org.broadleafcommerce.core.catalog.domain.CategoryImpl.setChildCategories(List<Category>)
org.broadleafcommerce.core.catalog.domain.Category.setChildCategoryURLMap(Map<String, List<Long>>) This approach is inherently inefficient and should no longer be used
org.broadleafcommerce.core.catalog.domain.CategoryImpl.setChildCategoryURLMap(Map<String, List<Long>>)
org.broadleafcommerce.core.offer.domain.Offer.setDeliveryType(OfferDeliveryType) Replaced by setAutomaticallyApplied(boolean val).
org.broadleafcommerce.core.pricing.service.module.SimpleTaxModule.setFactor(Double)
org.broadleafcommerce.core.catalog.domain.Sku.setListPrice(Money)
org.broadleafcommerce.core.catalog.domain.SkuImpl.setMachineSortable(Boolean)
org.broadleafcommerce.core.catalog.domain.Sku.setMachineSortable(Boolean) use Sku.setIsMachineSortable(Boolean) instead since that is the correct bean notation
org.broadleafcommerce.core.order.service.call.FulfillmentGroupRequest.setMethod(String)
org.broadleafcommerce.core.order.domain.FulfillmentGroupImpl.setMethod(String)
org.broadleafcommerce.core.order.domain.FulfillmentGroup.setMethod(String) Should use #setFulfillmentOption() instead
org.broadleafcommerce.core.order.domain.OrderItem.setOrderItemAdjustments(List<OrderItemAdjustment>) Item level adjustments are now stored at the OrderItemPriceDetail level instead to prevent unnecessary item splitting of OrderItems when evaluating promotions in the pricing engine.
org.broadleafcommerce.core.order.domain.OrderItem.setPrice(Money) Calling this method is the same as calling the following: OrderItem.setRetailPrice(Money) OrderItem.setSalePrice(Money) #setRetailPriceOverride(true) #setSalePriceOverride(true) #setDiscountingAllowed(false) This has the effect of setting the price in a way that no discounts or adjustments can be made.
org.broadleafcommerce.core.order.domain.FulfillmentGroup.setRetailShippingPrice(Money) - use FulfillmentGroup.setRetailFulfillmentPrice(Money) instead.
org.broadleafcommerce.core.order.domain.FulfillmentGroup.setSaleShippingPrice(Money) - use FulfillmentGroup.setSaleFulfillmentPrice(Money) instead.
org.broadleafcommerce.core.catalog.domain.CategoryAttribute.setSearchable(Boolean) in favor of Field configuration since 2.0
org.broadleafcommerce.core.order.service.call.FulfillmentGroupRequest.setService(String)
org.broadleafcommerce.core.order.domain.FulfillmentGroupImpl.setService(String)
org.broadleafcommerce.core.order.domain.FulfillmentGroup.setService(String) Should use #setFulfillmentOption() instead
org.broadleafcommerce.core.order.domain.FulfillmentGroup.setShippingPrice(Money) - use FulfillmentGroup.setRetailFulfillmentPrice(Money) instead.
org.broadleafcommerce.core.offer.domain.Offer.setStackable(boolean) calls Offer.setCombinableWithOtherOffers(boolean)
org.broadleafcommerce.core.order.domain.Order.setTotalShipping(Money) - Use Order.setTotalFulfillmentCharges(Money) instead.
org.broadleafcommerce.core.offer.domain.OfferImpl.setUses(int)
org.broadleafcommerce.core.offer.domain.OfferCodeImpl.setUses(int)
org.broadleafcommerce.core.offer.domain.OfferCode.setUses(int)
org.broadleafcommerce.core.offer.domain.Offer.setUses(int)