org.broadleafcommerce.core.catalog.service

Interface CatalogService

All Known Implementing Classes:

CatalogServiceImpl

public interface CatalogService

Method Summary

Modifier and Type	Method and Description
Category	createCategory()
Product	createProduct(ProductType productType)
Sku	createSku()
List<Product>	findActiveProductsByCategory(Category category)
List<Product>	findActiveProductsByCategory(Category category, Date currentDate) Deprecated. Use findActiveProductsByCategory
List<Product>	findActiveProductsByCategory(Category category, Date currentDate, int limit, int offset) Deprecated. Use #findActiveProductsByCategory(Category, limit, offset
List<Product>	findActiveProductsByCategory(Category category, int limit, int offset) Same as findActiveProductsByCategory(Category) but allowing for pagination.
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<Category>	findAllParentCategories()
List<Product>	findAllProducts()
List<Product>	findAllProducts(int limit, int offset)
List<Sku>	findAllSkus()
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.
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. Use findFilteredActiveProductsByCategory(Category, SearchCriteria)
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. Use findFilteredActiveProductsByCategory(Category, SearchCriteria)
List<Product>	findFilteredActiveProductsByQuery(String query, SearchCriteria searchCriteria) Given a search query and a SearchCriteria, returns the appropriate matching products
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.
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)
Map<String,List<Long>>	getChildCategoryURLMapByCategoryId(Long categoryId) Deprecated. this approach is inherently inefficient - don't use.
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)

Method Detail

saveProduct

Product saveProduct(Product product)

findProductById

Product findProductById(Long productId)

findProductByExternalId

Product findProductByExternalId(String externalId)

findProductsByName

List<Product> findProductsByName(String searchName)

findProductsByName

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. Res

Parameters:

searchName -

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

List<Product> findActiveProductsByCategory(Category category)

findActiveProductsByCategory

@Deprecated
List<Product> findActiveProductsByCategory(Category category,
                                                       Date currentDate)

Deprecated. Use findActiveProductsByCategory

Parameters:

category -

currentDate -

Returns:

findFilteredActiveProductsByCategory

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

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

Parameters:

category -

searchCriteria -

Returns:

the matching products

findFilteredActiveProductsByCategory

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

Deprecated. Use findFilteredActiveProductsByCategory(Category, SearchCriteria)

Parameters:

category -

currentDate -

searchCriteria -

Returns:

findFilteredActiveProductsByQuery

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

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

Parameters:

query -

searchCriteria -

Returns:

the matching products

findFilteredActiveProductsByQuery

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

Deprecated. Use findFilteredActiveProductsByCategory(Category, SearchCriteria)

findActiveProductsByCategory

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

Same as findActiveProductsByCategory(Category) but allowing for pagination.

Parameters:

category -

limit -

offset -

Returns:

findActiveProductsByCategory

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

Deprecated. Use #findActiveProductsByCategory(Category, limit, offset

findAutomaticProductBundles

List<ProductBundle> findAutomaticProductBundles()

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.

Returns:

saveCategory

Category saveCategory(Category category)

removeCategory

void removeCategory(Category category)

removeProduct

void removeProduct(Product product)

removeSku

void removeSku(Sku sku)

findCategoryById

Category findCategoryById(Long categoryId)

findCategoryByExternalId

Category findCategoryByExternalId(String externalId)

findCategoryByName

@Deprecated
Category findCategoryByName(String categoryName)

Deprecated.

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 findCategoriesByName(String) instead.

Parameters:

categoryName - the category name to search by

Returns:

the Category instance matching the categoryName

findCategoriesByName

List<Category> findCategoriesByName(String categoryName)

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

Parameters:

categoryName - the category name to search by

Returns:

the list of matching Category instances

findCategoriesByName

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

Retrieve a list of Category instances based on the search criteria

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

findAllCategories

List<Category> findAllCategories()

findAllCategories

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

findAllProducts

List<Product> findAllProducts()

findAllProducts

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

findProductsForCategory

List<Product> findProductsForCategory(Category category)

findProductsForCategory

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

saveSku

Sku saveSku(Sku sku)

saveSkuFee

SkuFee saveSkuFee(SkuFee fee)

findAllSkus

List<Sku> findAllSkus()

findSkusByIds

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

findSkuById

Sku findSkuById(Long skuId)

findSkuByExternalId

Sku findSkuByExternalId(String externalId)

findSkuByUpc

Sku findSkuByUpc(String upc)

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

Parameters:

upc -

Returns:

getChildCategoryURLMapByCategoryId

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

Deprecated. this approach is inherently inefficient - don't use.

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

Parameters:

categoryId - the parent category to which the children belong

Returns:

hierarchical map of all child categories

createCategory

Category createCategory()

createSku

Sku createSku()

createProduct

Product createProduct(ProductType productType)

findAllParentCategories

List<Category> findAllParentCategories()

findAllSubCategories

List<Category> findAllSubCategories(Category category)

findAllSubCategories

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

findActiveSubCategoriesByCategory

List<Category> findActiveSubCategoriesByCategory(Category category)

findActiveSubCategoriesByCategory

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

readAllProductOptions

List<ProductOption> readAllProductOptions()

saveProductOption

ProductOption saveProductOption(ProductOption option)

findProductOptionById

ProductOption findProductOptionById(Long productOptionId)

findProductOptionValueById

ProductOptionValue findProductOptionValueById(Long productOptionValueId)

findCategoryByURI

Category findCategoryByURI(String uri)

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

Parameters:

uri -

Returns:

findProductByURI

Product findProductByURI(String uri)

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

Parameters:

uri -

Returns:

findSkuByURI

Sku findSkuByURI(String uri)

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

Parameters:

uri -

Returns:

findAssignedProductOptionsByProductId

List<AssignedProductOptionDTO> findAssignedProductOptionsByProductId(Long productId)

Returns a list of AssignedProductOptionDTO found for given the productId.

Parameters:

productId -

Returns:

findAssignedProductOptionsByProduct

List<AssignedProductOptionDTO> findAssignedProductOptionsByProduct(Product product)

Returns a list of AssignedProductOptionDTO found for given the Product.

Parameters:

product -

Returns: