org.broadleafcommerce.core.catalog.domain

Class ProductBundleImpl

java.lang.Object

org.broadleafcommerce.core.catalog.domain.ProductImpl

org.broadleafcommerce.core.catalog.domain.ProductBundleImpl

All Implemented Interfaces:

Serializable, AdminMainEntity, MultiTenantCloneable<Product>, Status, TemplatePathContainer, Locatable, Indexable, Product, ProductBundle

@Entity
public class ProductBundleImpl
extends ProductImpl
implements ProductBundle

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.broadleafcommerce.core.catalog.domain.ProductImpl

ProductImpl.Presentation

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	autoBundle
protected Boolean	bundlePromotable
protected Boolean	itemsPromotable
protected String	pricingModel
protected Integer	priority
protected List<SkuBundleItem>	skuBundleItems

Fields inherited from class org.broadleafcommerce.core.catalog.domain.ProductImpl

additionalSkus, allParentCategoryXrefs, archiveStatus, canSellWithoutOptions, crossSaleProducts, defaultCategory, defaultSku, displayTemplate, id, isFeaturedProduct, manufacturer, model, overrideGeneratedUrl, productAttributes, productOptionMap, productOptions, promoMessage, skus, upSaleProducts, url, urlKey

Fields inherited from interface org.broadleafcommerce.common.admin.domain.AdminMainEntity

MAIN_ENTITY_NAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
ProductBundleImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	clearDynamicPrices() Removes any currently stored dynamic pricing
CreateResponse<ProductBundle>	createOrRetrieveCopyInstance(MultiTenantCopyContext context)
Boolean	getAutoBundle() Gets whether or not this should be bundled together if the individual Products are added to the cart.
Money	getBundleItemsRetailPrice()
Money	getBundleItemsSalePrice()
Boolean	getBundlePromotable() Gets whether or not the bundle itself should be promotable.
Boolean	getItemsPromotable() 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
BigDecimal	getPotentialSavings() Calculates the potential savings by summing up the retail prices of the contained items and comparing to the actual bundle prices.
ProductBundlePricingModelType	getPricingModel()
Integer	getPriority() Used to determine the order for automatic bundling.
Money	getRetailPrice() added just for convenience, references to defaultSku.retailPrice
Money	getSalePrice() added just for convenience, references defaultSku.retailPrice
List<SkuBundleItem>	getSkuBundleItems()
boolean	isOnSale()
void	setAutoBundle(Boolean autoBundle) Sets whether or not this should be bundled together if the individual Products are added to the cart.
void	setBundlePromotable(Boolean bundlePromotable) Gets whether or not the bundle itself should be promotable.
void	setItemsPromotable(Boolean itemsPromotable) 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
void	setPricingModel(ProductBundlePricingModelType pricingModel)
void	setPriority(Integer priority)
void	setSkuBundleItems(List<SkuBundleItem> skuBundleItems)

Methods inherited from class org.broadleafcommerce.core.catalog.domain.ProductImpl

equals, getActiveEndDate, getActiveStartDate, getAdditionalSkus, getAllParentCategories, getAllParentCategoryXrefs, getAllSkuMedia, getAllSkus, getArchived, getCanSellWithoutOptions, getCategory, getContainer, getCrossSaleProducts, getCumulativeCrossSaleProducts, getCumulativeUpSaleProducts, getDefaultCategory, getDefaultSku, getDepth, getDescription, getDimension, getDimensionString, getDisplayTemplate, getFieldEntityType, getGeneratedUrl, getGirth, getHeight, getId, getLocation, getLongDescription, getMainEntityName, getManufacturer, getMargin, getMedia, getModel, getName, getOverrideGeneratedUrl, getProductAttributes, getProductOptions, getProductOptionValuesMap, getProductOptionXrefs, getPromoMessage, getSize, getSkus, getTaxCode, getUpSaleProducts, getUrl, getUrlKey, getWeight, getWidth, hashCode, hasRetailPrice, isActive, isFeaturedProduct, setActiveEndDate, setActiveStartDate, setAdditionalSkus, setAllParentCategories, setAllParentCategoryXrefs, setArchived, setCanSellWithoutOptions, setCategory, setContainer, setCrossSaleProducts, setDefaultCategory, setDefaultSku, setDepth, setDescription, setDimension, setDisplayTemplate, setFeaturedProduct, setGirth, setHeight, setId, setLongDescription, setManufacturer, setMedia, setModel, setName, setOverrideGeneratedUrl, setProductAttributes, setProductOptions, setProductOptionXrefs, setPromoMessage, setSize, setTaxCode, setUpSaleProducts, setUrl, setUrlKey, setWeight, setWidth

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.broadleafcommerce.core.catalog.domain.Product

getActiveEndDate, getActiveStartDate, getAdditionalSkus, getAllParentCategories, getAllParentCategoryXrefs, getAllSkuMedia, getAllSkus, getCanSellWithoutOptions, getCategory, getContainer, getCrossSaleProducts, getCumulativeCrossSaleProducts, getCumulativeUpSaleProducts, getDefaultCategory, getDefaultSku, getDepth, getDescription, getDimension, getDimensionString, getDisplayTemplate, getGeneratedUrl, getGirth, getHeight, getId, getLongDescription, getManufacturer, getMargin, getMedia, getModel, getName, getOverrideGeneratedUrl, getProductAttributes, getProductOptions, getProductOptionValuesMap, getProductOptionXrefs, getPromoMessage, getSize, getSkus, getTaxCode, getUpSaleProducts, getUrl, getUrlKey, getWeight, getWidth, hasRetailPrice, isActive, isFeaturedProduct, setActiveEndDate, setActiveStartDate, setAdditionalSkus, setAllParentCategories, setAllParentCategoryXrefs, setCanSellWithoutOptions, setCategory, setContainer, setCrossSaleProducts, setDefaultCategory, setDefaultSku, setDepth, setDescription, setDimension, setDisplayTemplate, setFeaturedProduct, setGirth, setHeight, setId, setLongDescription, setManufacturer, setMedia, setModel, setName, setOverrideGeneratedUrl, setProductAttributes, setProductOptions, setProductOptionXrefs, setPromoMessage, setSize, setTaxCode, setUpSaleProducts, setUrl, setUrlKey, setWeight, setWidth

Methods inherited from interface org.broadleafcommerce.core.catalog.domain.Indexable

getFieldEntityType

Field Detail

pricingModel

protected String pricingModel

autoBundle

protected Boolean autoBundle

itemsPromotable

protected Boolean itemsPromotable

bundlePromotable

protected Boolean bundlePromotable

priority

protected Integer priority

skuBundleItems

protected List<SkuBundleItem> skuBundleItems

Constructor Detail

ProductBundleImpl

public ProductBundleImpl()

Method Detail

isOnSale

public boolean isOnSale()

Specified by:

isOnSale in interface ProductBundle

Returns:

whether or not the product bundle is on sale

getPricingModel

public ProductBundlePricingModelType getPricingModel()

Specified by:

getPricingModel in interface ProductBundle

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

public void setPricingModel(ProductBundlePricingModelType pricingModel)

Specified by:

setPricingModel in interface ProductBundle

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

public Money getRetailPrice()

Description copied from interface: Product

added just for convenience, references to defaultSku.retailPrice

Specified by:

getRetailPrice in interface Product

Specified by:

getRetailPrice in interface ProductBundle

Overrides:

getRetailPrice in class ProductImpl

Returns:

getSalePrice

public Money getSalePrice()

Description copied from interface: Product

added just for convenience, references defaultSku.retailPrice

Specified by:

getSalePrice in interface Product

Specified by:

getSalePrice in interface ProductBundle

Overrides:

getSalePrice in class ProductImpl

Returns:

getBundleItemsRetailPrice

public Money getBundleItemsRetailPrice()

Specified by:

getBundleItemsRetailPrice in interface ProductBundle

Returns:

the sum of the retail prices of the bundle items

getBundleItemsSalePrice

public Money getBundleItemsSalePrice()

Specified by:

getBundleItemsSalePrice in interface ProductBundle

Returns:

the sum of the sale prices of the bundle items

clearDynamicPrices

public void clearDynamicPrices()

Description copied from interface: Product

Removes any currently stored dynamic pricing

Specified by:

clearDynamicPrices in interface Product

Overrides:

clearDynamicPrices in class ProductImpl

getAutoBundle

public Boolean getAutoBundle()

Description copied from interface: ProductBundle

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

Specified by:

getAutoBundle in interface ProductBundle

Returns:

true if the items in this bundle should be automatically bundled together when added to the cart separately, false otherwise

setAutoBundle

public void setAutoBundle(Boolean autoBundle)

Description copied from interface: ProductBundle

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

Specified by:

setAutoBundle in interface ProductBundle

Parameters:

autoBundle - Whether or not the items in the bundle should be auto-bundled if added to the cart separately

getItemsPromotable

public Boolean getItemsPromotable()

Description copied from interface: ProductBundle

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

Specified by:

getItemsPromotable in interface ProductBundle

Returns:

true if the items should be included in the promotion engine, false otherwise

setItemsPromotable

public void setItemsPromotable(Boolean itemsPromotable)

Description copied from interface: ProductBundle

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

Specified by:

setItemsPromotable in interface ProductBundle

Parameters:

itemsPromotable - Whether or not the items in the bundle should be considered for promotions

getBundlePromotable

public Boolean getBundlePromotable()

Description copied from interface: ProductBundle

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

Specified by:

getBundlePromotable in interface ProductBundle

Returns:

true if the bundle itself should be available for promotion, false otherwise

setBundlePromotable

public void setBundlePromotable(Boolean bundlePromotable)

Description copied from interface: ProductBundle

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

Specified by:

setBundlePromotable in interface ProductBundle

Parameters:

bundlePromotable - Whether or not the bundle itself should be available for promotion

getSkuBundleItems

public List<SkuBundleItem> getSkuBundleItems()

Specified by:

getSkuBundleItems in interface ProductBundle

setSkuBundleItems

public void setSkuBundleItems(List<SkuBundleItem> skuBundleItems)

Specified by:

setSkuBundleItems in interface ProductBundle

getPriority

public Integer getPriority()

Description copied from interface: ProductBundle

Used to determine the order for automatic bundling.

Specified by:

getPriority in interface ProductBundle

Returns:

setPriority

public void setPriority(Integer priority)

Specified by:

setPriority in interface ProductBundle

getPotentialSavings

public BigDecimal getPotentialSavings()

Description copied from interface: ProductBundle

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.

Specified by:

getPotentialSavings in interface ProductBundle

Returns:

createOrRetrieveCopyInstance

public CreateResponse<ProductBundle> createOrRetrieveCopyInstance(MultiTenantCopyContext context)
                                                           throws CloneNotSupportedException

Specified by:

createOrRetrieveCopyInstance in interface MultiTenantCloneable<Product>

Overrides:

createOrRetrieveCopyInstance in class ProductImpl

Throws:

CloneNotSupportedException