de.hybris.platform.adaptivesearch.services

Interface AsSearchConfigurationService

All Known Implementing Classes:

DefaultAsSearchConfigurationService

public interface AsSearchConfigurationService

Service that provides basic functionality for search configurations.

Method Summary

Modifier and Type	Method and Description
<T extends AbstractAsSearchConfigurationModel> T	cloneSearchConfiguration(T searchConfiguration) Clones the given search configuration.
<T extends AbstractAsSearchConfigurationModel> java.util.List<T>	getAllSearchConfigurations() Returns all search configurations.
<T extends AbstractAsSearchConfigurationModel> T	getOrCreateSearchConfigurationForContext(AsSearchProfileContext context, AbstractAsSearchProfileModel searchProfile) Returns the search configuration for a specific context and search profile.
<T extends AbstractAsSearchConfigurationModel> java.util.Optional<T>	getSearchConfigurationForContext(AsSearchProfileContext context, AbstractAsSearchProfileModel searchProfile) Returns the search configuration for a specific context and search profile.
<T extends AbstractAsSearchConfigurationModel> java.util.Optional<T>	getSearchConfigurationForUid(CatalogVersionModel catalogVersion, java.lang.String uid) Returns the search configuration for a specific catalog version and uid.
AsSearchConfigurationInfoData	getSearchConfigurationInfoForContext(AsSearchProfileContext context, AbstractAsSearchProfileModel searchProfile) Returns search configuration related information for a specific context and search profile.
java.util.Set<java.lang.String>	getSearchConfigurationQualifiers(AbstractAsSearchProfileModel searchProfile) Gets the qualifiers for the search profile
<T extends AbstractAsSearchConfigurationModel> java.util.List<T>	getSearchConfigurationsForCatalogVersion(CatalogVersionModel catalogVersion) Returns all search configurations for a specific catalog version.

Method Detail

getAllSearchConfigurations

<T extends AbstractAsSearchConfigurationModel> java.util.List<T> getAllSearchConfigurations()

Returns all search configurations.

Returns:

list of search configurations or empty list if no configuration is found

getSearchConfigurationsForCatalogVersion

<T extends AbstractAsSearchConfigurationModel> java.util.List<T> getSearchConfigurationsForCatalogVersion(CatalogVersionModel catalogVersion)

Returns all search configurations for a specific catalog version.

Parameters:

catalogVersion - - the catalog version

Returns:

list of search configurations or empty list if no configuration is found

getSearchConfigurationForUid

<T extends AbstractAsSearchConfigurationModel> java.util.Optional<T> getSearchConfigurationForUid(CatalogVersionModel catalogVersion,
                                                                                                  java.lang.String uid)

Returns the search configuration for a specific catalog version and uid.

Parameters:

catalogVersion - - the catalog version

uid - - the unique identifier

Returns:

the search configuration

getSearchConfigurationForContext

<T extends AbstractAsSearchConfigurationModel> java.util.Optional<T> getSearchConfigurationForContext(AsSearchProfileContext context,
                                                                                                      AbstractAsSearchProfileModel searchProfile)

Returns the search configuration for a specific context and search profile.

Parameters:

context - - the search profile context

searchProfile - - the search profile

Returns:

the search configuration

getOrCreateSearchConfigurationForContext

<T extends AbstractAsSearchConfigurationModel> T getOrCreateSearchConfigurationForContext(AsSearchProfileContext context,
                                                                                          AbstractAsSearchProfileModel searchProfile)

Returns the search configuration for a specific context and search profile. If the search configuration does not yet exist a new one is created.

Parameters:

context - - the search profile context

searchProfile - - the search profile

Returns:

the search configuration

getSearchConfigurationInfoForContext

AsSearchConfigurationInfoData getSearchConfigurationInfoForContext(AsSearchProfileContext context,
                                                                   AbstractAsSearchProfileModel searchProfile)

Returns search configuration related information for a specific context and search profile.

Parameters:

context - - the search profile context

searchProfile - - the search profile

Returns:

the search configuration

cloneSearchConfiguration

<T extends AbstractAsSearchConfigurationModel> T cloneSearchConfiguration(T searchConfiguration)

Clones the given search configuration.

Parameters:

searchConfiguration - - the search configuration to be cloned

Returns:

- the cloned version

getSearchConfigurationQualifiers

java.util.Set<java.lang.String> getSearchConfigurationQualifiers(AbstractAsSearchProfileModel searchProfile)

Gets the qualifiers for the search profile

Parameters:

searchProfile - - the search profile

Returns:

qualifiers for the search profile