Interface SnCommonConfigurationService

All Known Implementing Classes:
DefaultSnCommonConfigurationService

public interface SnCommonConfigurationService
Service for configuration related functionality.
  • Method Details

    • getUser

      UserModel getUser(String indexTypeId)
      Returns the user for the given index type.
      Parameters:
      indexTypeId - - the index type
      Returns:
      the user
    • getLanguages

      List<LanguageModel> getLanguages(String indexTypeId)
      Returns the languages for the given index type.
      Parameters:
      indexTypeId - - the index type
      Returns:
      the languages
    • getCurrencies

      List<CurrencyModel> getCurrencies(String indexTypeId)
      Returns the currencies for the given index type.
      Parameters:
      indexTypeId - - the index type
      Returns:
      the currencies
    • getCatalogVersions

      List<CatalogVersionModel> getCatalogVersions(String indexTypeId)
      Returns the catalog versions for the given index type.
      Parameters:
      indexTypeId - - the index type
      Returns:
      the catalog versions
    • getFacetExpressions

      List<SnExpressionInfo> getFacetExpressions(String indexTypeId)
      Returns the valid facet expressions.
      Parameters:
      indexTypeId - - the index type
      Returns:
      the facet expressions
    • isValidFacetExpression

      boolean isValidFacetExpression(String indexTypeId, 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

      List<SnExpressionInfo> getSortExpressions(String indexTypeId)
      Returns the valid sort expressions.
      Parameters:
      indexTypeId - - the index type
      Returns:
      the sort expressions
    • isValidSortExpression

      boolean isValidSortExpression(String indexTypeId, 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

      List<SnExpressionInfo> getGroupExpressions(String indexTypeId)
      Returns the valid group expressions.
      Parameters:
      indexTypeId - - the index type
      Returns:
      the group expressions
    • isValidGroupExpression

      boolean isValidGroupExpression(String indexTypeId, 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(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(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