Interface AsSearchProvider
- All Known Implementing Classes:
DefaultAsSearchProviderFactory.CombinedSearchProvider,MockAsSearchProvider,SnAsSearchProvider,SolrAsSearchProvider
public interface AsSearchProvider
Represent the different search providers.
-
Method Summary
Modifier and TypeMethodDescriptiongetAvailableQualifiers(String indexType, String indexProperty) Return list of qualifiers for index property.Returns the index configuration for the provided code.Returns a list of index configurations.getIndexProperties(String indexType) Returns a list of index properties for a given index type.getIndexPropertyForCode(String indexType, String code) Returns the index property for the provided code.getIndexTypeForCode(String code) Returns the index type for the provided code.Returns a list of index types.getIndexTypes(String indexConfiguration) Returns a list of index types for a given index configuration.getSupportedBoostTypes(String indexType) Returns a list of boost types for a given index type.getSupportedCatalogVersions(String indexConfiguration, String indexType) Returns a list of catalog versions for a given index configuration and type.getSupportedCurrencies(String indexConfiguration, String indexType) Returns a list of currencies for a given index configuration and type.getSupportedFacetExpressions(String indexType) Returns a list of expressions for a given index type that can be used for facets.getSupportedFacetSorts(String indexType) Returns a list of facet sorts for a given index type.getSupportedFacetTypes(String indexType) Returns a list of facet types for a given index type.getSupportedFeatures(String indexType) Returns a list of supported features.getSupportedGroupExpressions(String indexType) Returns a list of expressions for a given index type that can be used for groups.getSupportedLanguages(String indexConfiguration, String indexType) Returns a list of languages for a given index configuration and type.getSupportedQueryContexts(String indexType) Returns a list of supported query contexts.getSupportedSortExpressions(String indexType) Returns a list of expressions for a given index type that can be used for sorts.booleanisValidBoostType(String indexType, AsBoostType boostType) Checks if a given boost type can be used for a given index type.booleanisValidFacetExpression(String indexType, String expression) Checks if a given index property can be used for facets.booleanisValidFacetSort(String indexType, String sort) Checks if a given sort can be used for facets.booleanisValidFacetType(String indexType, AsFacetType facetType) Checks if a given facet type can be used for a given index type.booleanisValidGroupExpression(String indexType, String expression) Checks if a given expression can be used for groups.booleanisValidSortExpression(String indexType, String expression) Checks if a given expression can be used for sorts.search(AsSearchProfileContext context, AsSearchQueryData searchQuery) Performs a search query.
-
Method Details
-
getSupportedFeatures
Returns a list of supported features.- Parameters:
indexType- - the index type code- Returns:
- the supported features
-
getSupportedQueryContexts
Returns a list of supported query contexts.- Returns:
- the supported query contexts
-
getIndexConfigurations
List<AsIndexConfigurationData> getIndexConfigurations()Returns a list of index configurations.- Returns:
- the index configurations
-
getIndexConfigurationForCode
Returns the index configuration for the provided code.- Parameters:
code- - the index configuration code- Returns:
- the index type
-
getIndexTypes
List<AsIndexTypeData> getIndexTypes()Returns a list of index types.- Returns:
- the index types
-
getIndexTypes
Returns a list of index types for a given index configuration.- Parameters:
indexConfiguration- - the index configuration code- Returns:
- the index types
-
getIndexTypeForCode
Returns the index type for the provided code.- Parameters:
code- - the index type code- Returns:
- the index type
-
getIndexProperties
Returns a list of index properties for a given index type.- Parameters:
indexType- - the index type code- Returns:
- the index properties
-
getIndexPropertyForCode
Returns the index property for the provided code.- Parameters:
code- - the index property code- Returns:
- the index property
-
getSupportedCatalogVersions
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
Returns a list of languages for a given index configuration and type.- Parameters:
indexConfiguration- - the index configurationindexType- - the index type- Returns:
- the languages
-
getSupportedCurrencies
Returns a list of currencies for a given index configuration and type.- Parameters:
indexConfiguration- - the index configurationindexType- - the index type- Returns:
- the currencies
-
getSupportedFacetExpressions
Returns a list of expressions for a given index type that can be used for facets.- Parameters:
indexType- - the index type code- Returns:
- the expressions
-
isValidFacetExpression
Checks if a given index property can be used for facets.- Parameters:
indexType- - the index type codeexpression- - the facet expression- Returns:
trueif expression can be used for facets,falseotherwise
-
getSupportedFacetTypes
Returns a list of facet types for a given index type.- Parameters:
indexType- - the index type code- Returns:
- the facet types
-
isValidFacetType
Checks if a given facet type can be used for a given index type.- Parameters:
indexType- - the index type codefacetType- - the facet type- Returns:
trueif facet type can be used,falseotherwise
-
getSupportedFacetSorts
Returns a list of facet sorts for a given index type.- Parameters:
indexType- - the index type code- Returns:
- the facet sorts
-
isValidFacetSort
Checks if a given sort can be used for facets.- Parameters:
indexType- - the index type codesort- - the sort- Returns:
trueif sort can be used for facets,falseotherwise
-
getSupportedBoostTypes
Returns a list of boost types for a given index type.- Parameters:
indexType- - the index type code- Returns:
- the boost types
-
isValidBoostType
Checks if a given boost type can be used for a given index type.- Parameters:
indexType- - the index type codeboostType- - the boost type- Returns:
trueif boost type can be used,falseotherwise
-
getSupportedSortExpressions
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
Checks if a given expression can be used for sorts.- Parameters:
indexType- - the index type codeexpression- - the sort expression- Returns:
trueif expression can be used for sorts,falseotherwise
-
getSupportedGroupExpressions
Returns a list of expressions for a given index type that can be used for groups.- Parameters:
indexType- - the index type code- Returns:
- the expressions
-
isValidGroupExpression
Checks if a given expression can be used for groups.- Parameters:
indexType- - the index type codeexpression- - the sort expression- Returns:
trueif expression can be used for groups,falseotherwise
-
getAvailableQualifiers
Return list of qualifiers for index property.- Parameters:
indexType- - the index type codeindexProperty- - the index property code- Returns:
- the qualifiers
- Throws:
AsException
-
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
-