com.broadleafcommerce.tenant.service.extension.solr

Class MultiTenantPriceListSolrIndexServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

org.broadleafcommerce.core.search.service.solr.index.AbstractSolrIndexServiceExtensionHandler

com.broadleafcommerce.pricelist.extension.PriceListSolrIndexServiceExtensionHandler

com.broadleafcommerce.tenant.service.extension.solr.MultiTenantPriceListSolrIndexServiceExtensionHandler

All Implemented Interfaces:

org.broadleafcommerce.common.extension.ExtensionHandler, org.broadleafcommerce.core.search.service.solr.index.SolrIndexServiceExtensionHandler

public class MultiTenantPriceListSolrIndexServiceExtensionHandler
extends com.broadleafcommerce.pricelist.extension.PriceListSolrIndexServiceExtensionHandler

This extension handler is an override for PriceListSolrIndexServiceExtensionHandler. This specifically was created to wrap and enhance the PriceListSolrIndexServiceExtensionHandler.attachChildDocuments(Indexable, SolrInputDocument, List, List) method in order to ensure that TEMPLATE-level Catalogs include STANDARD site override and default catalogs when building Price child documents. This allows users to create formula-based PriceLists on the site level that will be reflected in the search results without having to use SolrConfiguration.isSiteCollections().

Author:

Nick Crum ncrum

See Also:

PriceListSolrIndexServiceExtensionHandler

Field Summary

Fields inherited from class com.broadleafcommerce.pricelist.extension.PriceListSolrIndexServiceExtensionHandler

currencyService, environment, extensionManager, HUNDRED_YEARS_FROM_NOW_DATE, indexPriceListActiveDates, PRICE_LIST_CACHE_KEY, priceListService, priceListSkuService, shs, solrConfiguration

Fields inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

enabled, priority

Constructor Summary

Constructors

Constructor and Description
MultiTenantPriceListSolrIndexServiceExtensionHandler(org.broadleafcommerce.core.search.service.solr.index.SolrIndexServiceExtensionManager extensionManager, MultiTenantStateManager multiTenantStateManager, MultiTenantDao multiTenantDao)

Method Summary

Modifier and Type	Method and Description
org.broadleafcommerce.common.extension.ExtensionResultStatusType	addPropertyValues(org.broadleafcommerce.core.catalog.domain.Indexable indexable, org.broadleafcommerce.core.search.domain.Field field, org.broadleafcommerce.core.search.domain.solr.FieldType fieldType, Map<String,Object> values, String propertyName, List<org.broadleafcommerce.common.locale.domain.Locale> locales) Deprecated. This is deprecated in favor of using nested documents attachChildDocuments(Indexable, SolrInputDocument, List, List)
protected org.broadleafcommerce.common.extension.ExtensionResultStatusType	attachActiveDateFields(org.broadleafcommerce.core.catalog.domain.Sku sku, String skuFieldPrefix, org.apache.solr.common.SolrInputDocument document, org.broadleafcommerce.core.search.service.solr.SolrHelperService shs) Deprecated. This is deprecated in favor of using nested documents attachChildDocuments(Indexable, SolrInputDocument, List, List)
protected void	attachBasicPriceDocumentFields(org.broadleafcommerce.core.catalog.domain.Product product, com.broadleafcommerce.pricelist.domain.PriceList priceList, org.apache.solr.common.SolrInputDocument pricingDocument)
org.broadleafcommerce.common.extension.ExtensionResultStatusType	attachChildDocuments(org.broadleafcommerce.core.catalog.domain.Indexable indexable, org.apache.solr.common.SolrInputDocument document, List<org.broadleafcommerce.core.search.domain.IndexField> fields, List<org.broadleafcommerce.common.locale.domain.Locale> locales)
protected String	buildCacheKey(Long catalogId) Simply prepends the cache key prefix to the Catalog's ID.
protected org.broadleafcommerce.common.site.domain.Catalog	getCurrentCatalog()
protected org.broadleafcommerce.common.site.domain.Site	getCurrentSite()
protected String	getPriceListCatalogFieldName()
protected List<Long>	retrieveChildCatalogIdsIncludingParent(org.broadleafcommerce.common.site.domain.Catalog parent) Retrieve all of the implicit and default catalogs for any sites this catalog is assigned to.

Methods inherited from class com.broadleafcommerce.pricelist.extension.PriceListSolrIndexServiceExtensionHandler

attachAdditionalBasicFields, attachPriceFieldsIfExist, clearPriceListRequestContext, clearPricingContext, endBatchEvent, establishCurrency, extractPriceListFields, gatherPriceLists, getAllPriceLists, getDocumentType, getNonNullFutureDate, getPriceListActiveEndDateFieldName, getPriceListActiveStartDateFieldName, getPriceListIdFieldName, getPricelistPrefix, getPricelistPrefix, getPricelistPrefixWithSeparator, getPricelistPrefixWithSeparator, getPriceValue, getPriority, isContractPricingEnabled, isIndexPriceListActiveDates, isNestedPricingEnabled, isSalePricingEnabled, setIndexPriceListActiveDates, setupPricingContext, startBatchEvent

Methods inherited from class org.broadleafcommerce.core.search.service.solr.index.AbstractSolrIndexServiceExtensionHandler

attachAdditionalDocumentFields, getCategoryId, getIndexableId, modifyBuiltDocuments, populateDocumentForIndexField

Methods inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

isEnabled, setEnabled, setPriority

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.broadleafcommerce.core.search.service.solr.index.SolrIndexServiceExtensionHandler

attachAdditionalDocumentFields, getCategoryId, getIndexableId, modifyBuiltDocuments, populateDocumentForIndexField

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

isEnabled

Constructor Detail

MultiTenantPriceListSolrIndexServiceExtensionHandler

@Autowired
public MultiTenantPriceListSolrIndexServiceExtensionHandler(org.broadleafcommerce.core.search.service.solr.index.SolrIndexServiceExtensionManager extensionManager,
                                                                       MultiTenantStateManager multiTenantStateManager,
                                                                       MultiTenantDao multiTenantDao)

Method Detail

getPriceListCatalogFieldName

protected String getPriceListCatalogFieldName()

attachChildDocuments

public org.broadleafcommerce.common.extension.ExtensionResultStatusType attachChildDocuments(org.broadleafcommerce.core.catalog.domain.Indexable indexable,
                                                                                             org.apache.solr.common.SolrInputDocument document,
                                                                                             List<org.broadleafcommerce.core.search.domain.IndexField> fields,
                                                                                             List<org.broadleafcommerce.common.locale.domain.Locale> locales)

Specified by:

attachChildDocuments in interface org.broadleafcommerce.core.search.service.solr.index.SolrIndexServiceExtensionHandler

Overrides:

attachChildDocuments in class com.broadleafcommerce.pricelist.extension.PriceListSolrIndexServiceExtensionHandler

addPropertyValues

@Deprecated
public org.broadleafcommerce.common.extension.ExtensionResultStatusType addPropertyValues(org.broadleafcommerce.core.catalog.domain.Indexable indexable,
                                                                                                      org.broadleafcommerce.core.search.domain.Field field,
                                                                                                      org.broadleafcommerce.core.search.domain.solr.FieldType fieldType,
                                                                                                      Map<String,Object> values,
                                                                                                      String propertyName,
                                                                                                      List<org.broadleafcommerce.common.locale.domain.Locale> locales)
                                                                                               throws IllegalAccessException,
                                                                                                      InvocationTargetException,
                                                                                                      NoSuchMethodException

Deprecated. This is deprecated in favor of using nested documents attachChildDocuments(Indexable, SolrInputDocument, List, List)

Specified by:

addPropertyValues in interface org.broadleafcommerce.core.search.service.solr.index.SolrIndexServiceExtensionHandler

Overrides:

addPropertyValues in class com.broadleafcommerce.pricelist.extension.PriceListSolrIndexServiceExtensionHandler

Throws:

IllegalAccessException

InvocationTargetException

NoSuchMethodException

attachActiveDateFields

@Deprecated
protected org.broadleafcommerce.common.extension.ExtensionResultStatusType attachActiveDateFields(org.broadleafcommerce.core.catalog.domain.Sku sku,
                                                                                                              String skuFieldPrefix,
                                                                                                              org.apache.solr.common.SolrInputDocument document,
                                                                                                              org.broadleafcommerce.core.search.service.solr.SolrHelperService shs)

Deprecated. This is deprecated in favor of using nested documents attachChildDocuments(Indexable, SolrInputDocument, List, List)

Overrides:

attachActiveDateFields in class com.broadleafcommerce.pricelist.extension.PriceListSolrIndexServiceExtensionHandler

attachBasicPriceDocumentFields

protected void attachBasicPriceDocumentFields(org.broadleafcommerce.core.catalog.domain.Product product,
                                              com.broadleafcommerce.pricelist.domain.PriceList priceList,
                                              org.apache.solr.common.SolrInputDocument pricingDocument)

Overrides:

attachBasicPriceDocumentFields in class com.broadleafcommerce.pricelist.extension.PriceListSolrIndexServiceExtensionHandler

retrieveChildCatalogIdsIncludingParent

protected List<Long> retrieveChildCatalogIdsIncludingParent(org.broadleafcommerce.common.site.domain.Catalog parent)

Retrieve all of the implicit and default catalogs for any sites this catalog is assigned to. These catalogs will be used in order to ensure we include any standard-site level PriceList.

Parameters:

parent - the TEMPLATE level catalog.

Returns:

a List of the child catalogs including the parent

buildCacheKey

protected String buildCacheKey(Long catalogId)

Simply prepends the cache key prefix to the Catalog's ID.

Parameters:

catalogId - the catalog id of the TEMPLATE level Catalog

Returns:

the cache key

getCurrentCatalog

protected org.broadleafcommerce.common.site.domain.Catalog getCurrentCatalog()

getCurrentSite

protected org.broadleafcommerce.common.site.domain.Site getCurrentSite()