de.hybris.platform.commercesearch.searchandizing.searchprofile

Interface CategorySearchProfileService

All Known Implementing Classes:

DefaultCategorySearchProfileService

public interface CategorySearchProfileService

This interface contains methods related to category solr search profiles.

See Also:

CategorySearchProfileFacade

Method Summary

Modifier and Type	Method and Description
CategorySolrSearchProfileModel	createSolrSearchProfile(String categoryCode, SolrIndexedTypeModel solrIndexedTypeModel) This method returns a new category solr search profile based on given category code and solr indexed type.
CategorySolrSearchProfileModel	getCategorySolrSearchProfile(String categoryCode, SolrIndexedTypeModel indexedType) This method returns the exact solr search profile based on given category code and indexed type.
AbstractSolrSearchProfileModel	getEffectiveSolrFacetReconfigSearchProfile(CategoryModel categoryModel, SolrIndexedTypeModel indexedType) This method returns the effective solr search profile which contains facet reconfigurations.
AbstractSolrSearchProfileModel	getFacetSearchProfileForCategoryAndIndexedType(IndexedType indexedType, CategoryModel categoryModel, FacetSearchConfig facetSearchConfig) Returns the nearest match search profile that contains facet reconfiguration rules.

Method Detail

getEffectiveSolrFacetReconfigSearchProfile

AbstractSolrSearchProfileModel getEffectiveSolrFacetReconfigSearchProfile(CategoryModel categoryModel,
                                                                          SolrIndexedTypeModel indexedType)

This method returns the effective solr search profile which contains facet reconfigurations. When there is no exact match for a given category and indexed type then a search profile from parent category or a global profile will be returned.

Parameters:

categoryModel - Given category model.

indexedType - Given indexed type.

Returns:

Effective Solr Search Profile or null if no profile found.

getCategorySolrSearchProfile

CategorySolrSearchProfileModel getCategorySolrSearchProfile(String categoryCode,
                                                            SolrIndexedTypeModel indexedType)

This method returns the exact solr search profile based on given category code and indexed type.

Parameters:

categoryCode - Given category code.

indexedType - Given indexed type.

Returns:

Exact solr search profile or null.

createSolrSearchProfile

CategorySolrSearchProfileModel createSolrSearchProfile(String categoryCode,
                                                       SolrIndexedTypeModel solrIndexedTypeModel)

This method returns a new category solr search profile based on given category code and solr indexed type.

Parameters:

categoryCode - Given category code.

solrIndexedTypeModel - Given solr indexed type.

Returns:

New search profile based on given category code and solr indexed type.

getFacetSearchProfileForCategoryAndIndexedType

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

Returns the nearest match search profile that contains facet reconfiguration rules. If there exists a CategorySolrSearchProfileModel for the given category, then that is what gets returned, otherwise, the system will return the CategorySolrSearchProfileModel for nearest parent category with facet rules. If no category level search profiles are found, then the GlobalSolrSearchProfileModel will be returned. If that too is not defined or does not contain facet reconfiguration rules, then null will be the return result.

Parameters:

indexedType - The given IndexedType

categoryModel - The given category

facetSearchConfig - The given FacetSearchConfig

Returns:

The nearest matching search profile containing facet reconfiguration rules, or null if neither category nor global profiles are available