Interface SnCommonConfigurationService
- All Known Implementing Classes:
DefaultSnCommonConfigurationService
public interface SnCommonConfigurationService
Service for configuration related functionality.
-
Method Summary
Modifier and TypeMethodDescriptionbooleancanExportConfiguration(String indexConfigurationId) Returns whether the index configuration and everything associated can be exported to the search provider.voidexportConfiguration(String indexConfigurationId) Exports the index configuration and everything associated to the search provider.getCatalogVersions(String indexTypeId) Returns the catalog versions for the given index type.getCurrencies(String indexTypeId) Returns the currencies for the given index type.getFacetExpressions(String indexTypeId) Returns the valid facet expressions.getGroupExpressions(String indexTypeId) Returns the valid group expressions.getLanguages(String indexTypeId) Returns the languages for the given index type.getSortExpressions(String indexTypeId) Returns the valid sort expressions.Returns the user for the given index type.booleanisValidFacetExpression(String indexTypeId, String expression) Checks if a given expression is a valid facet expression.booleanisValidGroupExpression(String indexTypeId, String expression) Checks if a given expression is a valid group expression.booleanisValidSortExpression(String indexTypeId, String expression) Checks if a given expression is a valid sort expression.
-
Method Details
-
getUser
Returns the user for the given index type.- Parameters:
indexTypeId- - the index type- Returns:
- the user
-
getLanguages
Returns the languages for the given index type.- Parameters:
indexTypeId- - the index type- Returns:
- the languages
-
getCurrencies
Returns the currencies for the given index type.- Parameters:
indexTypeId- - the index type- Returns:
- the currencies
-
getCatalogVersions
Returns the catalog versions for the given index type.- Parameters:
indexTypeId- - the index type- Returns:
- the catalog versions
-
getFacetExpressions
Returns the valid facet expressions.- Parameters:
indexTypeId- - the index type- Returns:
- the facet expressions
-
isValidFacetExpression
Checks if a given expression is a valid facet expression.- Parameters:
indexTypeId- - the index typeexpression- - the expression- Returns:
trueif it is a valid facet expression,falseotherwise
-
getSortExpressions
Returns the valid sort expressions.- Parameters:
indexTypeId- - the index type- Returns:
- the sort expressions
-
isValidSortExpression
Checks if a given expression is a valid sort expression.- Parameters:
indexTypeId- - the index typeexpression- - the expression- Returns:
trueif it is a valid sort expression,falseotherwise
-
getGroupExpressions
Returns the valid group expressions.- Parameters:
indexTypeId- - the index type- Returns:
- the group expressions
-
isValidGroupExpression
Checks if a given expression is a valid group expression.- Parameters:
indexTypeId- - the index typeexpression- - the expression- Returns:
trueif it is a valid group expression,falseotherwise
-
canExportConfiguration
Returns whether the index configuration and everything associated can be exported to the search provider.- Parameters:
indexConfigurationId- - the index configuration id- Returns:
trueif the configuration can be exported,falseotherwise
-
exportConfiguration
Exports the index configuration and everything associated to the search provider.- Parameters:
indexConfigurationId- - the index configuration id- Throws:
SnException- if an error occurs
-