Interface FacetSearchConfigService
- All Known Implementing Classes:
DefaultFacetSearchConfigService,MockFacetSearchConfigService
public interface FacetSearchConfigService
This service provides access to the facet search configurations
-
Method Summary
Modifier and TypeMethodDescriptiongetConfiguration(CatalogVersionModel catalogVersion) Searches for the configuration for the specified catalog version.getConfiguration(String name) Returns the configuration by nameresolveIndexedProperties(FacetSearchConfig facetSearchConfig, IndexedType indexedType, Collection<String> indexedPropertiesIds) Resolves indexed properties by ids.resolveIndexedType(FacetSearchConfig facetSearchConfig, String indexedTypeName) Resolves indexed type by name.
-
Method Details
-
getConfiguration
Returns the configuration by name- Parameters:
name- - Name of configuration- Returns:
FacetSearchConfigobject- Throws:
FacetConfigServiceException- if an error occurs
-
getConfiguration
FacetSearchConfig getConfiguration(CatalogVersionModel catalogVersion) throws FacetConfigServiceException Searches for the configuration for the specified catalog version.- Parameters:
catalogVersion- the catalog version to be searched- Returns:
FacetSearchConfigif it is found. If more than one configurations can be found, return the first one. If it cannot be found, return null.- Throws:
FacetConfigServiceException- if an error occurs
-
resolveIndexedType
IndexedType resolveIndexedType(FacetSearchConfig facetSearchConfig, String indexedTypeName) throws FacetConfigServiceException Resolves indexed type by name.- Parameters:
facetSearchConfig- facet search configuration.indexedTypeName- name of indexed type- Returns:
IndexedType- Throws:
FacetConfigServiceException- if an error occurs
-
resolveIndexedProperties
List<IndexedProperty> resolveIndexedProperties(FacetSearchConfig facetSearchConfig, IndexedType indexedType, Collection<String> indexedPropertiesIds) throws FacetConfigServiceException Resolves indexed properties by ids.- Parameters:
facetSearchConfig- facet search configuration.indexedType- indexed typeindexedPropertiesIds- list of indexed properties ids- Returns:
- List of
IndexedProperty - Throws:
FacetConfigServiceException- if an error occurs
-