de.hybris.platform.adaptivesearch.services

Interface AsSearchProfileService

All Known Implementing Classes:

DefaultAsSearchProfileService

public interface AsSearchProfileService

Service that provides basic functionality for search profiles.

Method Summary

Modifier and Type	Method and Description
<T extends AbstractAsSearchProfileModel> T	cloneSearchProfile(T original) Creates a deep copy of the given search profile.
<T extends AbstractAsSearchProfileModel> java.util.List<T>	getAllSearchProfiles() Returns all search profiles.
<T extends AbstractAsSearchProfileModel> java.util.Optional<T>	getSearchProfileForCode(CatalogVersionModel catalogVersion, java.lang.String code) Returns the search profile a specific catalog version and code.
<T extends AbstractAsSearchProfileModel> java.util.List<T>	getSearchProfiles(java.lang.String query, java.util.Map<java.lang.String,java.lang.Object> filters) Returns search profiles.
<T extends AbstractAsSearchProfileModel> SearchPageData<T>	getSearchProfiles(java.lang.String query, java.util.Map<java.lang.String,java.lang.Object> filters, SearchPageData<?> pagination) Returns paginated search profiles.
<T extends AbstractAsSearchProfileModel> java.util.List<T>	getSearchProfilesForCatalogVersion(CatalogVersionModel catalogVersion) Returns all search profiles for a specific catalog version.
<T extends AbstractAsSearchProfileModel> java.util.List<T>	getSearchProfilesForIndexTypesAndCatalogVersions(java.util.List<java.lang.String> indexTypes, java.util.List<CatalogVersionModel> catalogVersions) Returns all search profiles for a list of index types and catalog versions.

Method Detail

getAllSearchProfiles

<T extends AbstractAsSearchProfileModel> java.util.List<T> getAllSearchProfiles()

Returns all search profiles.

Returns:

list of search profiles or empty list if no profile is found

getSearchProfilesForIndexTypesAndCatalogVersions

<T extends AbstractAsSearchProfileModel> java.util.List<T> getSearchProfilesForIndexTypesAndCatalogVersions(java.util.List<java.lang.String> indexTypes,
                                                                                                            java.util.List<CatalogVersionModel> catalogVersions)

Returns all search profiles for a list of index types and catalog versions.

Parameters:

indexTypes - - list of index types

catalogVersions - - list of catalog versions

Returns:

list of search profiles or empty list if no profile is found

getSearchProfilesForCatalogVersion

<T extends AbstractAsSearchProfileModel> java.util.List<T> getSearchProfilesForCatalogVersion(CatalogVersionModel catalogVersion)

Returns all search profiles for a specific catalog version.

Parameters:

catalogVersion - - the catalog version

Returns:

list of search profiles or empty list if no profile is found

getSearchProfileForCode

<T extends AbstractAsSearchProfileModel> java.util.Optional<T> getSearchProfileForCode(CatalogVersionModel catalogVersion,
                                                                                       java.lang.String code)

Returns the search profile a specific catalog version and code.

Parameters:

catalogVersion - - the catalog version

code - - the code

Returns:

the search profile

getSearchProfiles

<T extends AbstractAsSearchProfileModel> java.util.List<T> getSearchProfiles(java.lang.String query,
                                                                             java.util.Map<java.lang.String,java.lang.Object> filters)

Returns search profiles.

Parameters:

query - query parameter for filtering

filters - parameters for filtering

Returns:

list of search profiles or empty list if no profile is found

getSearchProfiles

<T extends AbstractAsSearchProfileModel> SearchPageData<T> getSearchProfiles(java.lang.String query,
                                                                             java.util.Map<java.lang.String,java.lang.Object> filters,
                                                                             SearchPageData<?> pagination)

Returns paginated search profiles.

Parameters:

query - query parameter for filtering

filters - parameters for filtering

pagination - holder of pagination data and sort options

Returns:

list of search profiles or empty list if no profile is found

cloneSearchProfile

<T extends AbstractAsSearchProfileModel> T cloneSearchProfile(T original)

Creates a deep copy of the given search profile. The resulting object is not persisted yet in order to allow modifications like unique key adjustments etc.

Parameters:

original - - the original search profile

Returns:

the deep copy of the search profile