Interface AsSearchProvider
-
- All Known Implementing Classes:
DefaultAsSearchProviderFactory.CombinedSearchProvider,MockAsSearchProvider,SolrAsSearchProvider
public interface AsSearchProviderRepresent the different search providers.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Optional<AsIndexConfigurationData>getIndexConfigurationForCode(java.lang.String code)Returns the index configuration for the provided code.java.util.List<AsIndexConfigurationData>getIndexConfigurations()Returns a list of index configurations.java.util.List<AsIndexPropertyData>getIndexProperties(java.lang.String indexType)Returns a list of index properties for a given index type.java.util.Optional<AsIndexPropertyData>getIndexPropertyForCode(java.lang.String indexType, java.lang.String code)Returns the index property for the provided code.java.util.Optional<AsIndexTypeData>getIndexTypeForCode(java.lang.String code)Returns the index type for the provided code.java.util.List<AsIndexTypeData>getIndexTypes()Returns a list of index types.java.util.List<AsIndexTypeData>getIndexTypes(java.lang.String indexConfiguration)Returns a list of index types for a given index configuration.java.util.List<CatalogVersionModel>getSupportedCatalogVersions(java.lang.String indexConfiguration, java.lang.String indexType)Returns a list of catalog versions for a given index configuration and type.java.util.List<CurrencyModel>getSupportedCurrencies(java.lang.String indexConfiguration, java.lang.String indexType)Returns a list of currencies for a given index configuration and type.java.util.List<AsIndexPropertyData>getSupportedFacetIndexProperties(java.lang.String indexType)Returns a list of index properties for a given index type that can be used for facets.java.util.List<LanguageModel>getSupportedLanguages(java.lang.String indexConfiguration, java.lang.String indexType)Returns a list of languages for a given index configuration and type.java.util.List<AsExpressionData>getSupportedSortExpressions(java.lang.String indexType)Returns a list of expressions for a given index type that can be used for sorts.booleanisValidFacetIndexProperty(java.lang.String indexType, java.lang.String code)Checks is a given index property can be used for facets.booleanisValidSortExpression(java.lang.String indexType, java.lang.String expression)Checks is a given expression can be used for facets.AsSearchResultDatasearch(AsSearchProfileContext context, AsSearchQueryData searchQuery)Performs a search query.
-
-
-
Method Detail
-
getIndexConfigurations
java.util.List<AsIndexConfigurationData> getIndexConfigurations()
Returns a list of index configurations.- Returns:
- the index configurations
-
getIndexConfigurationForCode
java.util.Optional<AsIndexConfigurationData> getIndexConfigurationForCode(java.lang.String code)
Returns the index configuration for the provided code.- Parameters:
code- - the index configuration code- Returns:
- the index type
-
getIndexTypes
java.util.List<AsIndexTypeData> getIndexTypes()
Returns a list of index types.- Returns:
- the index types
-
getIndexTypes
java.util.List<AsIndexTypeData> getIndexTypes(java.lang.String indexConfiguration)
Returns a list of index types for a given index configuration.- Parameters:
indexConfiguration- - the index configuration code- Returns:
- the index types
-
getIndexTypeForCode
java.util.Optional<AsIndexTypeData> getIndexTypeForCode(java.lang.String code)
Returns the index type for the provided code.- Parameters:
code- - the index type code- Returns:
- the index type
-
getIndexProperties
java.util.List<AsIndexPropertyData> getIndexProperties(java.lang.String indexType)
Returns a list of index properties for a given index type.- Parameters:
indexType- - the index type code- Returns:
- the index properties
-
getIndexPropertyForCode
java.util.Optional<AsIndexPropertyData> getIndexPropertyForCode(java.lang.String indexType, java.lang.String code)
Returns the index property for the provided code.- Parameters:
code- - the index property code- Returns:
- the index property
-
getSupportedCatalogVersions
java.util.List<CatalogVersionModel> getSupportedCatalogVersions(java.lang.String indexConfiguration, java.lang.String indexType)
Returns a list of catalog versions for a given index configuration and type.- Parameters:
indexConfiguration- - the index configurationindexType- - the index type- Returns:
- the catalog versions
-
getSupportedLanguages
java.util.List<LanguageModel> getSupportedLanguages(java.lang.String indexConfiguration, java.lang.String indexType)
Returns a list of languages for a given index configuration and type.- Parameters:
indexConfiguration- - the index configurationindexType- - the index type- Returns:
- the languages
-
getSupportedCurrencies
java.util.List<CurrencyModel> getSupportedCurrencies(java.lang.String indexConfiguration, java.lang.String indexType)
Returns a list of currencies for a given index configuration and type.- Parameters:
indexConfiguration- - the index configurationindexType- - the index type- Returns:
- the currencies
-
getSupportedFacetIndexProperties
java.util.List<AsIndexPropertyData> getSupportedFacetIndexProperties(java.lang.String indexType)
Returns a list of index properties for a given index type that can be used for facets.- Parameters:
indexType- - the index type code- Returns:
- the index properties
-
isValidFacetIndexProperty
boolean isValidFacetIndexProperty(java.lang.String indexType, java.lang.String code)Checks is a given index property can be used for facets.- Parameters:
indexType- - the index type codecode- - the code of the index property- Returns:
trueif the index property can be used for facets,falseotherwise
-
getSupportedSortExpressions
java.util.List<AsExpressionData> getSupportedSortExpressions(java.lang.String indexType)
Returns a list of expressions for a given index type that can be used for sorts.- Parameters:
indexType- - the index type code- Returns:
- the expressions
-
isValidSortExpression
boolean isValidSortExpression(java.lang.String indexType, java.lang.String expression)Checks is a given expression can be used for facets.- Parameters:
indexType- - the index type codeexpression- - the sort expression- Returns:
trueif expression can be used for sorts,falseotherwise
-
search
AsSearchResultData search(AsSearchProfileContext context, AsSearchQueryData searchQuery) throws AsException
Performs a search query.- Parameters:
context- - the search profile contextsearchQuery- - the search query- Throws:
AsException- if and exception occurs during the search- Since:
- 6.7
-
-