Interface ProductBundle
- All Superinterfaces:
Indexable,org.broadleafcommerce.common.copy.MultiTenantCloneable<Product>,Product,Serializable
- All Known Implementing Classes:
ProductBundleImpl
Deprecated.
instead, use the ProductType Module's Product Add-Ons to build and configure bundles
Default implementation for representing a bundle that can be sold
individually. Product bundles are composed of multiple
SkuBundleItem. Bundle prices are determined 1 of 2 ways, depending on the pricing model:
- ITEM_SUM: The sum of the prices of its
SkuBundleItem - BUNDLE: Uses the pricing information on the bundle itself
- Author:
- Phillip Verheyden
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Gets whether or not this should be bundled together if the individual Products are added to the cart.org.broadleafcommerce.common.money.MoneyDeprecated.org.broadleafcommerce.common.money.MoneyDeprecated.Deprecated.Gets whether or not the bundle itself should be promotable.Deprecated.Gets whether or not the items in this bundle should be considered for promotions using the promotion engine
Note: this is only applicable when the pricing model is the sum of the bundle items NOTE: THIS IS NOT YET SUPPORTED BY BROADLEAFDeprecated.Calculates the potential savings by summing up the retail prices of the contained items and comparing to the actual bundle prices.Deprecated.Deprecated.Used to determine the order for automatic bundling.org.broadleafcommerce.common.money.MoneyDeprecated.Returns the retail price for this bundleorg.broadleafcommerce.common.money.MoneyDeprecated.Returns the sale price for this bundleDeprecated.booleanisOnSale()Deprecated.Convenience method, references defaultSku.onSalevoidsetAutoBundle(Boolean autoBundle) Deprecated.Sets whether or not this should be bundled together if the individual Products are added to the cart.voidsetBundlePromotable(Boolean bundlePromotable) Deprecated.Gets whether or not the bundle itself should be promotable.voidsetItemsPromotable(Boolean itemsPromotable) Deprecated.Sets whether or not the items in this bundle should be considered for promotions using the promotion engine NOTE: THIS IS NOT YET SUPPORTED BY BROADLEAFvoidsetPricingModel(ProductBundlePricingModelType pricingModel) Deprecated.voidsetPriority(Integer priority) Deprecated.voidsetSkuBundleItems(List<SkuBundleItem> bundleItems) Deprecated.Methods inherited from interface org.broadleafcommerce.core.catalog.domain.Indexable
getFieldEntityTypeMethods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable
createOrRetrieveCopyInstanceMethods inherited from interface org.broadleafcommerce.core.catalog.domain.Product
clearDynamicPrices, getActiveEndDate, getActiveStartDate, getAdditionalSkus, getAllParentCategories, getAllParentCategoryIds, getAllParentCategoryXrefs, getAllSellableSkus, getAllSkuMedia, getAllSkus, getCanonicalUrl, getCanSellWithoutOptions, getCategory, getContainer, getCrossSaleProducts, getCumulativeCrossSaleProducts, getCumulativeUpSaleProducts, getDefaultCategory, getDefaultSku, getDepth, getDescription, getDimension, getDimensionString, getDisplayTemplate, getEnableDefaultSkuInInventory, getExternalId, getGeneratedUrl, getGirth, getHeight, getId, getLongDescription, getManufacturer, getMargin, getMedia, getMetaDescription, getMetaTitle, getModel, getMultiValueProductAttributes, getName, getOverrideGeneratedUrl, getParentCategoryHierarchyIds, getPrice, getProductAttributes, getProductOptions, getProductOptionValuesMap, getProductOptionXrefs, getPromoMessage, getSize, getSkus, getTaxCode, getUpSaleProducts, getUrl, getUrlKey, getWeight, getWidth, hasRetailPrice, isActive, setActiveEndDate, setActiveStartDate, setAdditionalSkus, setAllParentCategories, setAllParentCategoryXrefs, setCanonicalUrl, setCanSellWithoutOptions, setCategory, setContainer, setCrossSaleProducts, setDefaultCategory, setDefaultSku, setDepth, setDescription, setDimension, setDisplayTemplate, setEnableDefaultSkuInInventory, setGirth, setHeight, setId, setLongDescription, setManufacturer, setMedia, setMetaDescription, setMetaTitle, setModel, setName, setOverrideGeneratedUrl, setProductAttributes, setProductOptions, setProductOptionXrefs, setPromoMessage, setSize, setTaxCode, setUpSaleProducts, setUrl, setUrlKey, setWeight, setWidth
-
Method Details
-
getPricingModel
ProductBundlePricingModelType getPricingModel()Deprecated.- Returns:
- The pricing model for this bundle
ITEM_SUM indicates that the bundle is priced by the sum of the contained items. BUNDLE indicates that the bundle is priced by the price on the bundle itself.
-
setPricingModel
Deprecated.- Parameters:
pricingModel- ITEM_SUM if the retailPrice and salePrice of this bundle should be the composition of its items, BUNDLE if this retailPrice and salePrice should come from the default Sku
-
getRetailPrice
org.broadleafcommerce.common.money.Money getRetailPrice()Deprecated.Returns the retail price for this bundle- Specified by:
getRetailPricein interfaceProduct- Returns:
-
getSalePrice
org.broadleafcommerce.common.money.Money getSalePrice()Deprecated.Returns the sale price for this bundle- Specified by:
getSalePricein interfaceProduct- Returns:
-
getBundleItemsRetailPrice
org.broadleafcommerce.common.money.Money getBundleItemsRetailPrice()Deprecated.- Returns:
- the sum of the retail prices of the bundle items
-
getBundleItemsSalePrice
org.broadleafcommerce.common.money.Money getBundleItemsSalePrice()Deprecated.- Returns:
- the sum of the sale prices of the bundle items
-
getAutoBundle
Boolean getAutoBundle()Deprecated.Gets whether or not this should be bundled together if the individual Products are added to the cart. For instance, if this Bundle is composed of Item1 and Item2, and the user adds Item1 and Item2 to the cart separately, if this is true then these items will be bundled into a single BundleOrderItem instead of unique items in the cart NOTE: THIS IS NOT YET SUPPORTED BY BROADLEAF- Returns:
- true if the items in this bundle should be automatically bundled together when added to the cart separately, false otherwise
-
setAutoBundle
Deprecated.Sets whether or not this should be bundled together if the individual Products are added to the cart. For instance, if this Bundle is composed of Item1 and Item2, and the user adds Item1 and Item2 to the cart separately, if this is true then these items will be bundled into a single BundleOrderItem instead of unique items in the cart NOTE: THIS IS NOT YET SUPPORTED BY BROADLEAF- Parameters:
autoBundle- Whether or not the items in the bundle should be auto-bundled if added to the cart separately
-
getItemsPromotable
Boolean getItemsPromotable()Deprecated.Gets whether or not the items in this bundle should be considered for promotions using the promotion engine
Note: this is only applicable when the pricing model is the sum of the bundle items NOTE: THIS IS NOT YET SUPPORTED BY BROADLEAF- Returns:
- true if the items should be included in the promotion engine, false otherwise
-
setItemsPromotable
Deprecated.Sets whether or not the items in this bundle should be considered for promotions using the promotion engine NOTE: THIS IS NOT YET SUPPORTED BY BROADLEAF- Parameters:
itemsPromotable- Whether or not the items in the bundle should be considered for promotions
-
getBundlePromotable
Boolean getBundlePromotable()Deprecated.Gets whether or not the bundle itself should be promotable.
Note: this should only be used if the pricing model for the bundle uses the pricing on the bundle itself and not on the sum of its bundle items NOTE: THIS IS NOT YET SUPPORTED BY BROADLEAF- Returns:
- true if the bundle itself should be available for promotion, false otherwise
-
setBundlePromotable
Deprecated.Gets whether or not the bundle itself should be promotable.
Note: this should only be used if the pricing model for the bundle uses the pricing on the bundle itself and not on the sum of its bundle items NOTE: THIS IS NOT YET SUPPORTED BY BROADLEAF- Parameters:
bundlePromotable- Whether or not the bundle itself should be available for promotion
-
getSkuBundleItems
List<SkuBundleItem> getSkuBundleItems()Deprecated. -
setSkuBundleItems
Deprecated. -
getPriority
Integer getPriority()Deprecated.Used to determine the order for automatic bundling.- Returns:
-
setPriority
Deprecated. -
getPotentialSavings
BigDecimal getPotentialSavings()Deprecated.Calculates the potential savings by summing up the retail prices of the contained items and comparing to the actual bundle prices.Used to determine the order for automatic bundling in case items might qualify for multiple bundles.
- Returns:
-
isOnSale
boolean isOnSale()Deprecated.Description copied from interface:ProductConvenience method, references defaultSku.onSale
-