Package de.hybris.platform.adaptivesearch.strategies

Interface AsSearchProvider

    • Method Detail

      • getSupportedFeatures

        java.util.Set<AsFeatureFlag> getSupportedFeatures​(java.lang.String indexType)
        Returns a list of supported features.
        Parameters:
        indexType - - the index type code
        Returns:
        the supported features

      • 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 configuration
        indexType - - 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 configuration
        indexType - - 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 configuration
        indexType - - the index type
        Returns:
        the currencies

      • getSupportedFacetIndexProperties

        @Deprecated(since="2011")
java.util.List<AsIndexPropertyData> getSupportedFacetIndexProperties​(java.lang.String indexType)
        Deprecated.
        Replaced by getSupportedFacetExpressions(String).
        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

        @Deprecated(since="2011")
boolean isValidFacetIndexProperty​(java.lang.String indexType,
                                  java.lang.String code)
        Deprecated.
        Replaced by isValidFacetExpression(String, String).
        Checks is a given index property can be used for facets.
        Parameters:
        indexType - - the index type code
        code - - the code of the index property
        Returns:
        true if the index property can be used for facets, false otherwise

      • getSupportedFacetExpressions

        java.util.List<AsExpressionData> getSupportedFacetExpressions​(java.lang.String indexType)
        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

        boolean isValidFacetExpression​(java.lang.String indexType,
                               java.lang.String expression)
        Checks if a given index property can be used for facets.
        Parameters:
        indexType - - the index type code
        expression - - the facet expression
        Returns:
        true if expression can be used for facets, false otherwise

      • getSupportedFacetTypes

        java.util.List<AsFacetType> getSupportedFacetTypes​(java.lang.String indexType)
        Returns a list of facet types for a given index type.
        Parameters:
        indexType - - the index type code
        Returns:
        the facet types

      • isValidFacetType

        boolean isValidFacetType​(java.lang.String indexType,
                         AsFacetType facetType)
        Checks if a given facet type can be used for a given index type.
        Parameters:
        indexType - - the index type code
        facetType - - the facet type
        Returns:
        true if facet type can be used, false otherwise

      • getSupportedFacetSorts

        java.util.List<AsFacetSortData> getSupportedFacetSorts​(java.lang.String indexType)
        Returns a list of facet sorts for a given index type.
        Parameters:
        indexType - - the index type code
        Returns:
        the facet sorts

      • isValidFacetSort

        boolean isValidFacetSort​(java.lang.String indexType,
                         java.lang.String sort)
        Checks if a given sort can be used for facets.
        Parameters:
        indexType - - the index type code
        sort - - the sort
        Returns:
        true if sort can be used for facets, false otherwise

      • getSupportedBoostTypes

        java.util.List<AsBoostType> getSupportedBoostTypes​(java.lang.String indexType)
        Returns a list of boost types for a given index type.
        Parameters:
        indexType - - the index type code
        Returns:
        the boost types

      • isValidBoostType

        boolean isValidBoostType​(java.lang.String indexType,
                         AsBoostType boostType)
        Checks if a given boost type can be used for a given index type.
        Parameters:
        indexType - - the index type code
        boostType - - the boost type
        Returns:
        true if boost type can be used, false otherwise

      • 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 if a given expression can be used for sorts.
        Parameters:
        indexType - - the index type code
        expression - - the sort expression
        Returns:
        true if expression can be used for sorts, false otherwise

      • getSupportedGroupExpressions

        java.util.List<AsExpressionData> getSupportedGroupExpressions​(java.lang.String indexType)
        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

        boolean isValidGroupExpression​(java.lang.String indexType,
                               java.lang.String expression)
        Checks if a given expression can be used for groups.
        Parameters:
        indexType - - the index type code
        expression - - the sort expression
        Returns:
        true if expression can be used for groups, false otherwise

      • getAvailableQualifiers

        java.util.List<java.lang.String> getAvailableQualifiers​(java.lang.String indexType,
                                                        java.lang.String indexProperty)
                                                 throws AsException
        Return list of qualifiers for index property.
        Parameters:
        indexType - - the index type code
        indexProperty - - the index property code
        Returns:
        the qualifiers
        Throws:
        AsException