Package de.hybris.platform.solrfacetsearch.config

Interface FacetSearchConfigService

All Known Implementing Classes:

DefaultFacetSearchConfigService, MockFacetSearchConfigService

public interface FacetSearchConfigService

This service provides access to the facet search configurations

Method Summary

Modifier and Type	Method	Description
FacetSearchConfig	getConfiguration(CatalogVersionModel catalogVersion)	Searches for the configuration for the specified catalog version.
FacetSearchConfig	getConfiguration(java.lang.String name)	Returns the configuration by name
java.util.List<IndexedProperty>	resolveIndexedProperties(FacetSearchConfig facetSearchConfig, IndexedType indexedType, java.util.Collection<java.lang.String> indexedPropertiesIds)	Resolves indexed properties by ids.
IndexedType	resolveIndexedType(FacetSearchConfig facetSearchConfig, java.lang.String indexedTypeName)	Resolves indexed type by name.

Method Detail

getConfiguration

FacetSearchConfig getConfiguration(java.lang.String name)
                            throws FacetConfigServiceException

Returns the configuration by name

Parameters:

name - - Name of configuration

Returns:

FacetSearchConfig object

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:

FacetSearchConfig if 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,
                               java.lang.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

java.util.List<IndexedProperty> resolveIndexedProperties(FacetSearchConfig facetSearchConfig,
                                                         IndexedType indexedType,
                                                         java.util.Collection<java.lang.String> indexedPropertiesIds)
                                                  throws FacetConfigServiceException

Resolves indexed properties by ids.

Parameters:

facetSearchConfig - facet search configuration.

indexedType - indexed type

indexedPropertiesIds - list of indexed properties ids

Returns:

List of IndexedProperty

Throws:

FacetConfigServiceException - if an error occurs