Package org.broadleafcommerce.core.catalog.service

Class CatalogServiceImpl

java.lang.Object

org.broadleafcommerce.core.catalog.service.CatalogServiceImpl

All Implemented Interfaces:

CatalogService

@Service("blCatalogService")
public class CatalogServiceImpl
extends Object
implements CatalogService

Field Summary

Fields

Modifier and Type	Field	Description
protected CategoryDao	categoryDao
protected CatalogServiceExtensionManager	extensionManager
protected ProductDao	productDao
protected ProductOptionDao	productOptionDao
protected SkuDao	skuDao

Constructor Summary

Constructors

Constructor	Description
CatalogServiceImpl()

Method Summary

Modifier and Type	Method	Description
Long	countProductsUsingProductOptionById(Long productOptionId)
protected CatalogContextDTO	createCatalogContextDTO()
Category	createCategory()
Product	createProduct(ProductType productType)
Sku	createSku()
List<Product>	findActiveProductsByCategory(Category category)
List<Product>	findActiveProductsByCategory(Category category, int limit, int offset)	Same as CatalogService.findActiveProductsByCategory(Category) but allowing for pagination.
List<Product>	findActiveProductsByCategory(Category category, Date currentDate, int limit, int offset)	Deprecated, for removal: This API element is subject to removal in a future version.
List<Category>	findActiveSubCategoriesByCategory(Category category)
List<Category>	findActiveSubCategoriesByCategory(Category category, int limit, int offset)
List<Category>	findAllCategories()
List<Category>	findAllCategories(int limit, int offset)
List<Product>	findAllProducts()
List<Product>	findAllProducts(int limit, int offset)
List<Sku>	findAllSkus()
List<Sku>	findAllSkus(int offset, int limit)
List<Category>	findAllSubCategories(Category category)
List<Category>	findAllSubCategories(Category category, int limit, int offset)
List<AssignedProductOptionDTO>	findAssignedProductOptionsByProduct(Product product)	Returns a list of AssignedProductOptionDTO found for given the Product.
List<AssignedProductOptionDTO>	findAssignedProductOptionsByProductId(Long productId)	Returns a list of AssignedProductOptionDTO found for given the productId.
List<ProductBundle>	findAutomaticProductBundles()	Find all ProductBundles whose automatic attribute is set to true.
List<Category>	findCategoriesByName(String categoryName)	Retrieve a list of Category instance based on the name property.
List<Category>	findCategoriesByName(String categoryName, int limit, int offset)	Retrieve a list of Category instances based on the search criteria
Category	findCategoryByExternalId(String externalId)
Category	findCategoryById(Long categoryId)
Category	findCategoryByName(String categoryName)	Deprecated, for removal: This API element is subject to removal in a future version.
Category	findCategoryByURI(String uri)	Returns a category associated with the passed in URI or null if no Category is mapped to this URI.
List<Product>	findFilteredActiveProductsByCategory(Category category, Date currentDate, SearchCriteria searchCriteria)	Deprecated, for removal: This API element is subject to removal in a future version.
List<Product>	findFilteredActiveProductsByCategory(Category category, SearchCriteria searchCriteria)	Given a category and a ProudctSearchCriteria, returns the appropriate matching products
List<Product>	findFilteredActiveProductsByQuery(String query, Date currentDate, SearchCriteria searchCriteria)	Deprecated, for removal: This API element is subject to removal in a future version.
List<Product>	findFilteredActiveProductsByQuery(String query, SearchCriteria searchCriteria)	Given a search query and a SearchCriteria, returns the appropriate matching products
Category	findOriginalCategoryByURI(String uri)
Product	findOriginalProductByURI(String uri)
Product	findProductByExternalId(String externalId)
Product	findProductById(Long productId)
Product	findProductByURI(String uri)	Returns a product associated with the passed in URI or null if no Product is mapped to this URI.
List<Long>	findProductIdsUsingProductOptionById(Long productId, int start, int pageSize)	Returns a paginated list of Product Ids that are using the passed in ProductOption ID
ProductOption	findProductOptionById(Long productOptionId)
ProductOptionValue	findProductOptionValueById(Long productOptionValueId)
List<Product>	findProductsByName(String searchName)
List<Product>	findProductsByName(String searchName, int limit, int offset)	Find a subset of Product instances whose name starts with or is equal to the passed in search parameter.
List<Product>	findProductsForCategory(Category category)
List<Product>	findProductsForCategory(Category category, int limit, int offset)
Sku	findSkuByExternalId(String externalId)
Sku	findSkuById(Long skuId)
Sku	findSkuByUpc(String upc)	Method to look up a Sku by the Universal Product Code (UPC).
Sku	findSkuByURI(String uri)	Returns a sku associated with the passed in URI or null if no sku is mapped to this URI.
List<Sku>	findSkusByIds(List<Long> ids)
Long	findTotalCategoryCount()
Map<String,List<Long>>	getChildCategoryURLMapByCategoryId(Long categoryId)	Deprecated.
List<ProductOption>	readAllProductOptions()
void	removeCategory(Category category)
void	removeProduct(Product product)
void	removeSku(Sku sku)
Category	saveCategory(Category category)
Product	saveProduct(Product product)
ProductOption	saveProductOption(ProductOption option)
Sku	saveSku(Sku sku)
SkuFee	saveSkuFee(SkuFee fee)
void	setCategoryDao(CategoryDao categoryDao)
void	setProductDao(ProductDao productDao)
void	setSkuDao(SkuDao skuDao)
String	translateItemAttributeValue(OrderItemAttribute itemAttribute, ProductOption productOption)	Returns a translated String attribute value for OrderItemAttribute

Methods inherited from class java.lang.Object

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

Field Details

categoryDao

protected CategoryDao categoryDao

productDao

protected ProductDao productDao

skuDao

protected SkuDao skuDao

productOptionDao

protected ProductOptionDao productOptionDao

extensionManager

protected CatalogServiceExtensionManager extensionManager

Constructor Details

CatalogServiceImpl

public CatalogServiceImpl()

Method Details

findProductById

public Product findProductById(Long productId)

Specified by:

findProductById in interface CatalogService

findProductByExternalId

public Product findProductByExternalId(String externalId)

Specified by:

findProductByExternalId in interface CatalogService

findProductsByName

public List<Product> findProductsByName(String searchName)

Specified by:

findProductsByName in interface CatalogService

findProductsByName

public List<Product> findProductsByName(String searchName,
 int limit,
 int offset)

Description copied from interface: CatalogService

Find a subset of Product instances whose name starts with or is equal to the passed in search parameter. Res

Specified by:

findProductsByName in interface CatalogService

limit - the maximum number of results

offset - the starting point in the record set

Returns:

the list of product instances that fit the search criteria

findActiveProductsByCategory

public List<Product> findActiveProductsByCategory(Category category)

Specified by:

findActiveProductsByCategory in interface CatalogService

findFilteredActiveProductsByCategory

public List<Product> findFilteredActiveProductsByCategory(Category category,
 SearchCriteria searchCriteria)

Description copied from interface: CatalogService

Given a category and a ProudctSearchCriteria, returns the appropriate matching products

Specified by:

findFilteredActiveProductsByCategory in interface CatalogService

Returns:

the matching products

findFilteredActiveProductsByQuery

public List<Product> findFilteredActiveProductsByQuery(String query,
 SearchCriteria searchCriteria)

Description copied from interface: CatalogService

Given a search query and a SearchCriteria, returns the appropriate matching products

Specified by:

findFilteredActiveProductsByQuery in interface CatalogService

Returns:

the matching products

findActiveProductsByCategory

public List<Product> findActiveProductsByCategory(Category category,
 int limit,
 int offset)

Description copied from interface: CatalogService

Same as CatalogService.findActiveProductsByCategory(Category) but allowing for pagination.

Specified by:

findActiveProductsByCategory in interface CatalogService

Returns:

findFilteredActiveProductsByCategory

@Deprecated(forRemoval=true)
public List<Product> findFilteredActiveProductsByCategory(Category category,
 Date currentDate,
 SearchCriteria searchCriteria)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

findFilteredActiveProductsByCategory in interface CatalogService

Returns:

findFilteredActiveProductsByQuery

@Deprecated(forRemoval=true)
public List<Product> findFilteredActiveProductsByQuery(String query,
 Date currentDate,
 SearchCriteria searchCriteria)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

findFilteredActiveProductsByQuery in interface CatalogService

findActiveProductsByCategory

@Deprecated(forRemoval=true)
public List<Product> findActiveProductsByCategory(Category category,
 Date currentDate,
 int limit,
 int offset)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

findActiveProductsByCategory in interface CatalogService

findAutomaticProductBundles

public List<ProductBundle> findAutomaticProductBundles()

Description copied from interface: CatalogService

Find all ProductBundles whose automatic attribute is set to true.

Automatic product bundles are collections of products that can receive special pricing. With automatic product bundles, if a customer adds all of the components of the bundle individually to the cart, they will automatically get assembeled into a bundle.

Specified by:

findAutomaticProductBundles in interface CatalogService

Returns:

saveProduct

@Transactional("blTransactionManager")
public Product saveProduct(Product product)

Specified by:

saveProduct in interface CatalogService

findCategoryById

public Category findCategoryById(Long categoryId)

Specified by:

findCategoryById in interface CatalogService

findCategoryByExternalId

public Category findCategoryByExternalId(String externalId)

Specified by:

findCategoryByExternalId in interface CatalogService

findCategoryByName

@Deprecated(forRemoval=true)
public Category findCategoryByName(String categoryName)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: CatalogService

Retrieve a Category instance based on its name property.

Broadleaf allows more than one category to have the same name. Calling this method could produce an exception in such situations. Use CatalogService.findCategoriesByName(String) instead.

Specified by:

findCategoryByName in interface CatalogService

Parameters:

categoryName - the category name to search by

Returns:

the Category instance matching the categoryName

findCategoriesByName

public List<Category> findCategoriesByName(String categoryName)

Description copied from interface: CatalogService

Retrieve a list of Category instance based on the name property.

Specified by:

findCategoriesByName in interface CatalogService

Parameters:

categoryName - the category name to search by

Returns:

the list of matching Category instances

findCategoriesByName

public List<Category> findCategoriesByName(String categoryName,
 int limit,
 int offset)

Description copied from interface: CatalogService

Retrieve a list of Category instances based on the search criteria

Specified by:

findCategoriesByName in interface CatalogService

Parameters:

categoryName - the name of the category to search by

limit - the maximum number of results to return

offset - the starting point of the records to return

Returns:

a list of category instances that match the search criteria

saveCategory

@Transactional("blTransactionManager")
public Category saveCategory(Category category)

Specified by:

saveCategory in interface CatalogService

removeCategory

@Transactional("blTransactionManager")
public void removeCategory(Category category)

Specified by:

removeCategory in interface CatalogService

removeSku

@Transactional("blTransactionManager")
public void removeSku(Sku sku)

Specified by:

removeSku in interface CatalogService

removeProduct

@Transactional("blTransactionManager")
public void removeProduct(Product product)

Specified by:

removeProduct in interface CatalogService

findAllCategories

public List<Category> findAllCategories()

Specified by:

findAllCategories in interface CatalogService

findAllCategories

public List<Category> findAllCategories(int limit,
 int offset)

Specified by:

findAllCategories in interface CatalogService

findTotalCategoryCount

public Long findTotalCategoryCount()

Specified by:

findTotalCategoryCount in interface CatalogService

findAllSubCategories

public List<Category> findAllSubCategories(Category category)

Specified by:

findAllSubCategories in interface CatalogService

findAllSubCategories

public List<Category> findAllSubCategories(Category category,
 int limit,
 int offset)

Specified by:

findAllSubCategories in interface CatalogService

findActiveSubCategoriesByCategory

public List<Category> findActiveSubCategoriesByCategory(Category category)

Specified by:

findActiveSubCategoriesByCategory in interface CatalogService

findActiveSubCategoriesByCategory

public List<Category> findActiveSubCategoriesByCategory(Category category,
 int limit,
 int offset)

Specified by:

findActiveSubCategoriesByCategory in interface CatalogService

findAllProducts

public List<Product> findAllProducts()

Specified by:

findAllProducts in interface CatalogService

findAllProducts

public List<Product> findAllProducts(int limit,
 int offset)

Specified by:

findAllProducts in interface CatalogService

findAllSkus

public List<Sku> findAllSkus()

Specified by:

findAllSkus in interface CatalogService

findAllSkus

public List<Sku> findAllSkus(int offset,
 int limit)

Specified by:

findAllSkus in interface CatalogService

findSkuById

public Sku findSkuById(Long skuId)

Specified by:

findSkuById in interface CatalogService

findSkuByExternalId

public Sku findSkuByExternalId(String externalId)

Specified by:

findSkuByExternalId in interface CatalogService

findSkuByUpc

public Sku findSkuByUpc(String upc)

Description copied from interface: CatalogService

Method to look up a Sku by the Universal Product Code (UPC).

Specified by:

findSkuByUpc in interface CatalogService

Returns:

saveSku

@Transactional("blTransactionManager")
public Sku saveSku(Sku sku)

Specified by:

saveSku in interface CatalogService

saveSkuFee

@Transactional("blTransactionManager")
public SkuFee saveSkuFee(SkuFee fee)

Specified by:

saveSkuFee in interface CatalogService

findSkusByIds

public List<Sku> findSkusByIds(List<Long> ids)

Specified by:

findSkusByIds in interface CatalogService

setProductDao

public void setProductDao(ProductDao productDao)

setSkuDao

public void setSkuDao(SkuDao skuDao)

findProductsForCategory

public List<Product> findProductsForCategory(Category category)

Specified by:

findProductsForCategory in interface CatalogService

findProductsForCategory

public List<Product> findProductsForCategory(Category category,
 int limit,
 int offset)

Specified by:

findProductsForCategory in interface CatalogService

setCategoryDao

public void setCategoryDao(CategoryDao categoryDao)

getChildCategoryURLMapByCategoryId

@Deprecated
public Map<String,List<Long>> getChildCategoryURLMapByCategoryId(Long categoryId)

Deprecated.

Description copied from interface: CatalogService

Get a hierarchical map of all child categories keyed on the url

Specified by:

getChildCategoryURLMapByCategoryId in interface CatalogService

Parameters:

categoryId - the parent category to which the children belong

Returns:

hierarchical map of all child categories

createCategory

public Category createCategory()

Specified by:

createCategory in interface CatalogService

createSku

public Sku createSku()

Specified by:

createSku in interface CatalogService

createProduct

public Product createProduct(ProductType productType)

Specified by:

createProduct in interface CatalogService

readAllProductOptions

public List<ProductOption> readAllProductOptions()

Specified by:

readAllProductOptions in interface CatalogService

saveProductOption

@Transactional("blTransactionManager")
public ProductOption saveProductOption(ProductOption option)

Specified by:

saveProductOption in interface CatalogService

findProductOptionById

public ProductOption findProductOptionById(Long productOptionId)

Specified by:

findProductOptionById in interface CatalogService

findProductOptionValueById

public ProductOptionValue findProductOptionValueById(Long productOptionValueId)

Specified by:

findProductOptionValueById in interface CatalogService

createCatalogContextDTO

protected CatalogContextDTO createCatalogContextDTO()

findCategoryByURI

public Category findCategoryByURI(String uri)

Description copied from interface: CatalogService

Returns a category associated with the passed in URI or null if no Category is mapped to this URI.

Specified by:

findCategoryByURI in interface CatalogService

Returns:

findOriginalCategoryByURI

public Category findOriginalCategoryByURI(String uri)

Specified by:

findOriginalCategoryByURI in interface CatalogService

findProductByURI

public Product findProductByURI(String uri)

Description copied from interface: CatalogService

Returns a product associated with the passed in URI or null if no Product is mapped to this URI.

Specified by:

findProductByURI in interface CatalogService

Returns:

findOriginalProductByURI

public Product findOriginalProductByURI(String uri)

Specified by:

findOriginalProductByURI in interface CatalogService

findSkuByURI

public Sku findSkuByURI(String uri)

Description copied from interface: CatalogService

Returns a sku associated with the passed in URI or null if no sku is mapped to this URI.

Specified by:

findSkuByURI in interface CatalogService

Returns:

findAssignedProductOptionsByProductId

public List<AssignedProductOptionDTO> findAssignedProductOptionsByProductId(Long productId)

Description copied from interface: CatalogService

Returns a list of AssignedProductOptionDTO found for given the productId.

Specified by:

findAssignedProductOptionsByProductId in interface CatalogService

Returns:

findAssignedProductOptionsByProduct

public List<AssignedProductOptionDTO> findAssignedProductOptionsByProduct(Product product)

Description copied from interface: CatalogService

Returns a list of AssignedProductOptionDTO found for given the Product.

Specified by:

findAssignedProductOptionsByProduct in interface CatalogService

Returns:

countProductsUsingProductOptionById

public Long countProductsUsingProductOptionById(Long productOptionId)

Specified by:

countProductsUsingProductOptionById in interface CatalogService

findProductIdsUsingProductOptionById

public List<Long> findProductIdsUsingProductOptionById(Long productId,
 int start,
 int pageSize)

Description copied from interface: CatalogService

Returns a paginated list of Product Ids that are using the passed in ProductOption ID

Specified by:

findProductIdsUsingProductOptionById in interface CatalogService

Returns:

translateItemAttributeValue

public String translateItemAttributeValue(OrderItemAttribute itemAttribute,
 ProductOption productOption)

Description copied from interface: CatalogService

Returns a translated String attribute value for OrderItemAttribute

Specified by:

translateItemAttributeValue in interface CatalogService

Returns: