de.hybris.platform.commercesearch.searchandizing.boost

Interface BoostService

All Known Implementing Classes:

DefaultBoostService

public interface BoostService

This interface provides methods to retrieve search profiles containing product boost rules. Search profiles can be designated as global or by category. Currently there can exist only one global profile per IndexedType, and similarly only one category search profile per category. Both types of search profiles inherit from the type AbstractSolrSearchProfileModel.

Method Summary

Modifier and Type	Method and Description
SolrBoostRuleModel	createBoostRule(IndexedType indexedType, SolrFacetSearchConfigModel facetSearchConfig, String categoryCode, BoostRuleData boostRuleData) Creates and returns a new boost rule based on a given indexed type and facet search config.
AbstractSolrSearchProfileModel	getBoostProfileForCategoryAndIndexedType(IndexedType indexedType, CategoryModel categoryModel, FacetSearchConfig facetSearchConfig) Searches and returns a Solr Search Profile Model which exactly matches or is the nearest to a given category, indexedType and facetSearchConfig.
Collection<SolrBoostRuleModel>	getBoostRulesForCategoryAndIndexedType(IndexedType indexedType, CategoryModel categoryModel, FacetSearchConfig facetSearchConfig) Returns all boost rules for a given category, indexedType and facetSearchConfig.
Collection<SolrBoostRuleModel>	getBoostRulesForGlobalSearchProfile(IndexedType indexedType, FacetSearchConfig facetSearchConfig) Returns all boost rules for a given indexedType and facetSearchConfig that are defined in a GlobalSolrSearchProfile
AbstractSolrSearchProfileModel	getProfileForCategoryAndIndexedType(IndexedType indexedType, CategoryModel categoryModel, FacetSearchConfig facetSearchConfig) Searches and returns a Solr Search Profile Model which exactly matches the given category, indexedType and facetSearchConfig.
void	removeSolrBoostRule(String pk) Shortcut method to remove the SolrBoostRuleModel with the given pk.

Method Detail

getBoostRulesForCategoryAndIndexedType

Collection<SolrBoostRuleModel> getBoostRulesForCategoryAndIndexedType(IndexedType indexedType,
                                                                      CategoryModel categoryModel,
                                                                      FacetSearchConfig facetSearchConfig)

Returns all boost rules for a given category, indexedType and facetSearchConfig.

Parameters:

indexedType - The given IndexedType

categoryModel - The given category

facetSearchConfig - The given facetSearchConfig

Returns:

A collection containing all the product boost rules from the nearest matching search profile or empty list when neither category nor global search profiles are found

getBoostRulesForGlobalSearchProfile

Collection<SolrBoostRuleModel> getBoostRulesForGlobalSearchProfile(IndexedType indexedType,
                                                                   FacetSearchConfig facetSearchConfig)

Returns all boost rules for a given indexedType and facetSearchConfig that are defined in a GlobalSolrSearchProfile

Parameters:

indexedType - The given IndexedType

facetSearchConfig - The given facetSearchConfig

Returns:

A collection containing all the product boost rules from the GlobalSolrSearchProfile or empty list when no global search profiles are found

getBoostProfileForCategoryAndIndexedType

AbstractSolrSearchProfileModel getBoostProfileForCategoryAndIndexedType(IndexedType indexedType,
                                                                        CategoryModel categoryModel,
                                                                        FacetSearchConfig facetSearchConfig)

Searches and returns a Solr Search Profile Model which exactly matches or is the nearest to a given category, indexedType and facetSearchConfig.

Parameters:

indexedType - The given indexed type

categoryModel - The given category

facetSearchConfig - The given facet search config

Returns:

a AbstractSolrSearchProfileModel instance which is found.

removeSolrBoostRule

void removeSolrBoostRule(String pk)

Shortcut method to remove the SolrBoostRuleModel with the given pk.

Parameters:

pk - the pk of the SolrBoostRuleModel which will be removed.

createBoostRule

SolrBoostRuleModel createBoostRule(IndexedType indexedType,
                                   SolrFacetSearchConfigModel facetSearchConfig,
                                   String categoryCode,
                                   BoostRuleData boostRuleData)

Creates and returns a new boost rule based on a given indexed type and facet search config. The new boost rule will be assigned to the new or existing search profile.

Parameters:

indexedType - The given facet indexed type

facetSearchConfig - The given facet search config

categoryCode - The given category code, if category code is null then the boost rule will be assigned to the global search profile.

boostRuleData - The boostRuleData contains parameter which are needed for boost rule creation (like operatorType, boostFactor, propertyName, propertyValue)

Returns:

Returns a new created SolrBoostRuleModel.

getProfileForCategoryAndIndexedType

AbstractSolrSearchProfileModel getProfileForCategoryAndIndexedType(IndexedType indexedType,
                                                                   CategoryModel categoryModel,
                                                                   FacetSearchConfig facetSearchConfig)

Searches and returns a Solr Search Profile Model which exactly matches the given category, indexedType and facetSearchConfig. If no profile is found, then null is returned.

Parameters:

indexedType - The given indexed type

categoryModel - The given category

facetSearchConfig - The given facet search config

Returns:

a AbstractSolrSearchProfileModel instance which is found or null if no profile is found.