Package de.hybris.platform.searchservices.admin.service

Interface SnCommonConfigurationService

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean canExportConfiguration​(java.lang.String indexConfigurationId)
      Returns whether the index configuration and everything associated can be exported to the search provider.
      void exportConfiguration​(java.lang.String indexConfigurationId)
      Exports the index configuration and everything associated to the search provider.
      java.util.List<CatalogVersionModel> getCatalogVersions​(java.lang.String indexTypeId)
      Returns the catalog versions for the given index type.
      java.util.List<CurrencyModel> getCurrencies​(java.lang.String indexTypeId)
      Returns the currencies for the given index type.
      java.util.List<SnExpressionInfo> getFacetExpressions​(java.lang.String indexTypeId)
      Returns the valid facet expressions.
      java.util.List<SnExpressionInfo> getGroupExpressions​(java.lang.String indexTypeId)
      Returns the valid group expressions.
      java.util.List<LanguageModel> getLanguages​(java.lang.String indexTypeId)
      Returns the languages for the given index type.
      java.util.List<SnExpressionInfo> getSortExpressions​(java.lang.String indexTypeId)
      Returns the valid sort expressions.
      UserModel getUser​(java.lang.String indexTypeId)
      Returns the user for the given index type.
      boolean isValidFacetExpression​(java.lang.String indexTypeId, java.lang.String expression)
      Checks if a given expression is a valid facet expression.
      boolean isValidGroupExpression​(java.lang.String indexTypeId, java.lang.String expression)
      Checks if a given expression is a valid group expression.
      boolean isValidSortExpression​(java.lang.String indexTypeId, java.lang.String expression)
      Checks if a given expression is a valid sort expression.

    • Method Detail

      • getUser

        UserModel getUser​(java.lang.String indexTypeId)
        Returns the user for the given index type.
        Parameters:
        indexTypeId - - the index type
        Returns:
        the user

      • getLanguages

        java.util.List<LanguageModel> getLanguages​(java.lang.String indexTypeId)
        Returns the languages for the given index type.
        Parameters:
        indexTypeId - - the index type
        Returns:
        the languages

      • getCurrencies

        java.util.List<CurrencyModel> getCurrencies​(java.lang.String indexTypeId)
        Returns the currencies for the given index type.
        Parameters:
        indexTypeId - - the index type
        Returns:
        the currencies

      • getCatalogVersions

        java.util.List<CatalogVersionModel> getCatalogVersions​(java.lang.String indexTypeId)
        Returns the catalog versions for the given index type.
        Parameters:
        indexTypeId - - the index type
        Returns:
        the catalog versions

      • getFacetExpressions

        java.util.List<SnExpressionInfo> getFacetExpressions​(java.lang.String indexTypeId)
        Returns the valid facet expressions.
        Parameters:
        indexTypeId - - the index type
        Returns:
        the facet expressions

      • isValidFacetExpression

        boolean isValidFacetExpression​(java.lang.String indexTypeId,
                               java.lang.String expression)
        Checks if a given expression is a valid facet expression.
        Parameters:
        indexTypeId - - the index type
        expression - - the expression
        Returns:
        true if it is a valid facet expression, false otherwise

      • getSortExpressions

        java.util.List<SnExpressionInfo> getSortExpressions​(java.lang.String indexTypeId)
        Returns the valid sort expressions.
        Parameters:
        indexTypeId - - the index type
        Returns:
        the sort expressions

      • isValidSortExpression

        boolean isValidSortExpression​(java.lang.String indexTypeId,
                              java.lang.String expression)
        Checks if a given expression is a valid sort expression.
        Parameters:
        indexTypeId - - the index type
        expression - - the expression
        Returns:
        true if it is a valid sort expression, false otherwise

      • getGroupExpressions

        java.util.List<SnExpressionInfo> getGroupExpressions​(java.lang.String indexTypeId)
        Returns the valid group expressions.
        Parameters:
        indexTypeId - - the index type
        Returns:
        the group expressions

      • isValidGroupExpression

        boolean isValidGroupExpression​(java.lang.String indexTypeId,
                               java.lang.String expression)
        Checks if a given expression is a valid group expression.
        Parameters:
        indexTypeId - - the index type
        expression - - the expression
        Returns:
        true if it is a valid group expression, false otherwise

      • canExportConfiguration

        boolean canExportConfiguration​(java.lang.String indexConfigurationId)
        Returns whether the index configuration and everything associated can be exported to the search provider.
        Parameters:
        indexConfigurationId - - the index configuration id
        Returns:
        true if the configuration can be exported, false otherwise

      • exportConfiguration

        void exportConfiguration​(java.lang.String indexConfigurationId)
                  throws SnException
        Exports the index configuration and everything associated to the search provider.
        Parameters:
        indexConfigurationId - - the index configuration id
        Throws:
        SnException - if an error occurs