com.broadleafcommerce.cap.service

Interface CatalogAccessPolicyService

All Known Implementing Classes:

CatalogAccessPolicyServiceImpl

public interface CatalogAccessPolicyService

This service is responsible for determining catalog access policies.

Author:

Nick Crum ncrum

See Also:

CatalogAccessPolicy

Method Summary

Modifier and Type	Method and Description
boolean	attachCatalogAccessPolicyFiltersIfPossible(org.broadleafcommerce.core.search.service.solr.SearchContextDTO context, org.apache.solr.client.solrj.SolrQuery solrQuery) This method is responsible for creating and attaching the filter queries for any catalog access policies.
List<String>	createSolrFiltersForPolicy(CatalogAccessPolicy policy) This method generates the filter queries for SolrQuery to filter search results.
List<CatalogAccessPolicy>	findAllActivePolicies() This method retrieves all of the active policies and orders them by priority.
CatalogAccessPolicy	findById(Long id) This retrieves the CatalogAccessPolicy by primary key.
CatalogAccessPolicy	findCatalogAccessPolicyForCustomer(org.broadleafcommerce.profile.core.domain.Customer customer) This method retrieves the highest priority policy for the given customer.
boolean	validateCategoryForPolicy(CatalogAccessPolicy policy, org.broadleafcommerce.core.catalog.domain.Category category) This method evaluates whether the given Category is valid for the given CatalogAccessPolicy.
boolean	validateProductForPolicy(CatalogAccessPolicy policy, org.broadleafcommerce.core.catalog.domain.Product product) This method evaluates whether the given Product is valid for the given CatalogAccessPolicy.

Method Detail

findById

CatalogAccessPolicy findById(Long id)

This retrieves the CatalogAccessPolicy by primary key.

Parameters:

id - the primary key

Returns:

the policy with the primary key

findAllActivePolicies

List<CatalogAccessPolicy> findAllActivePolicies()

This method retrieves all of the active policies and orders them by priority.

Returns:

the active policies

findCatalogAccessPolicyForCustomer

CatalogAccessPolicy findCatalogAccessPolicyForCustomer(org.broadleafcommerce.profile.core.domain.Customer customer)

This method retrieves the highest priority policy for the given customer.

Parameters:

customer - the Customer

Returns:

the CatalogAccessPolicy

validateProductForPolicy

boolean validateProductForPolicy(CatalogAccessPolicy policy,
                                 org.broadleafcommerce.core.catalog.domain.Product product)

This method evaluates whether the given Product is valid for the given CatalogAccessPolicy.

Parameters:

policy - the policy

product - the product to check if valid

Returns:

whether the product is valid for the policy

validateCategoryForPolicy

boolean validateCategoryForPolicy(CatalogAccessPolicy policy,
                                  org.broadleafcommerce.core.catalog.domain.Category category)

This method evaluates whether the given Category is valid for the given CatalogAccessPolicy.

Parameters:

policy - the policy

category - the category to check if valid

Returns:

whether the category is valid for the policy

attachCatalogAccessPolicyFiltersIfPossible

boolean attachCatalogAccessPolicyFiltersIfPossible(org.broadleafcommerce.core.search.service.solr.SearchContextDTO context,
                                                   org.apache.solr.client.solrj.SolrQuery solrQuery)

This method is responsible for creating and attaching the filter queries for any catalog access policies.

Parameters:

context - the SearchContextDTO for the search query

solrQuery - the SolrQuery

Returns:

whether the filters were attached or not

createSolrFiltersForPolicy

List<String> createSolrFiltersForPolicy(CatalogAccessPolicy policy)

This method generates the filter queries for SolrQuery to filter search results.

Parameters:

policy - the policy

Returns:

a List of filters