com.broadleafcommerce.enterprise.common.extension.search

Interface WorkflowSolrIndexServiceExtensionHandler

All Superinterfaces:

org.broadleafcommerce.common.extension.ExtensionHandler

All Known Implementing Classes:

AbstractWorkflowSolrIndexServiceExtensionHandler

public interface WorkflowSolrIndexServiceExtensionHandler
extends org.broadleafcommerce.common.extension.ExtensionHandler

Author:

Andre Azzolini (apazzolini), Phillip Verheyden (phillipuniverse)

Method Summary

Modifier and Type	Method and Description
org.broadleafcommerce.common.extension.ExtensionResultStatusType	attachAdditionalDeleteDocumentFields(org.broadleafcommerce.core.catalog.domain.Indexable indexable, org.apache.solr.common.SolrInputDocument doc) When a product is deleted in the sandbox, a new Solr document is created that represents the deleted item.
org.broadleafcommerce.common.extension.ExtensionResultStatusType	buildAdditionalDeploymentDocuments(List<Long> indexableIds, List<? extends org.broadleafcommerce.core.catalog.domain.Indexable> indexables, List<org.apache.solr.common.SolrInputDocument> builtDocs) Invoked after documents are built on a DeployState.PRODUCTION deployment in Enterprise
org.broadleafcommerce.common.extension.ExtensionResultStatusType	getAdditionalDeleteQueryClause(org.broadleafcommerce.common.extension.ExtensionResultHolder<String> erh) Returns additional strings to append to the production delete query for Solr indexing
org.broadleafcommerce.common.extension.ExtensionResultStatusType	isCurrentSiteIndexable(org.broadleafcommerce.common.extension.ExtensionResultHolder<Boolean> holder)

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

getPriority, isEnabled

Method Detail

getAdditionalDeleteQueryClause

org.broadleafcommerce.common.extension.ExtensionResultStatusType getAdditionalDeleteQueryClause(org.broadleafcommerce.common.extension.ExtensionResultHolder<String> erh)

Returns additional strings to append to the production delete query for Solr indexing

Parameters:

erh -

Returns:

whether or not the ExtensionResultHolder has a String

attachAdditionalDeleteDocumentFields

org.broadleafcommerce.common.extension.ExtensionResultStatusType attachAdditionalDeleteDocumentFields(org.broadleafcommerce.core.catalog.domain.Indexable indexable,
                                                                                                      org.apache.solr.common.SolrInputDocument doc)

When a product is deleted in the sandbox, a new Solr document is created that represents the deleted item. This method provides the opportunity to customize the fields that are attached to the given doc

Parameters:

product -

buildAdditionalDeploymentDocuments

org.broadleafcommerce.common.extension.ExtensionResultStatusType buildAdditionalDeploymentDocuments(List<Long> indexableIds,
                                                                                                    List<? extends org.broadleafcommerce.core.catalog.domain.Indexable> indexables,
                                                                                                    List<org.apache.solr.common.SolrInputDocument> builtDocs)
                                                                                             throws org.broadleafcommerce.common.exception.ServiceException

Invoked after documents are built on a DeployState.PRODUCTION deployment in Enterprise

Parameters:

indexableIds - the original id set passed to com.broadleafcommerce.enterprise.workflow.service.search.WorkflowSolrIndexService#getSolrDocuments

indexables - corresponds to the database-backed entities of indexableIds. Assuming the default filters were enabled (which is the default) this should be the same size as indexableIds

builtDocs - the SolrInputDocuments that were already built naturally from a deployment event

Returns:

Throws:

org.broadleafcommerce.common.exception.ServiceException

isCurrentSiteIndexable

org.broadleafcommerce.common.extension.ExtensionResultStatusType isCurrentSiteIndexable(org.broadleafcommerce.common.extension.ExtensionResultHolder<Boolean> holder)