de.hybris.platform.platformbackoffice.services

Interface BackofficeSavedQueriesService

All Known Implementing Classes:

BackofficeSavedQueriesServiceImpl

public interface BackofficeSavedQueriesService

A service for BackofficeSavedQueryModel

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NOT_CONVERTED_ATTRIBUTE_VALUES Attribute name in AdvancedSearchInitContext which contains not converted attributes values.

Method Summary

Modifier and Type	Method and Description
BackofficeSavedQueryModel	createSavedQuery(java.util.Map<java.util.Locale,java.lang.String> queryName, AdvancedSearchData advancedSearchData, UserModel userModel, java.util.List<UserGroupModel> groups) Creates saved query from AdvancedSearchInitContext
AdvancedSearchInitContext	getAdvancedSearchInitContext(BackofficeSavedQueryModel savedQueryModel) Converts saved query model to advanced search context which can be passes to advancedSearchWidget.
java.util.List<BackofficeSavedQueryModel>	getSavedQueries(UserModel userModel) Searches saved queries for specified user.

Field Detail

NOT_CONVERTED_ATTRIBUTE_VALUES

static final java.lang.String NOT_CONVERTED_ATTRIBUTE_VALUES

Attribute name in AdvancedSearchInitContext which contains not converted attributes values.

See Also:

Constant Field Values

Method Detail

getSavedQueries

java.util.List<BackofficeSavedQueryModel> getSavedQueries(UserModel userModel)

Searches saved queries for specified user. In includes all queries which have user as an owner BackofficeSavedQueryModel.getQueryOwner() and all which have at least one of user's groups is in query's groups BackofficeSavedQueryModel.getUserGroups().

Parameters:

userModel - owner of a query

Returns:

saved queries.

createSavedQuery

BackofficeSavedQueryModel createSavedQuery(java.util.Map<java.util.Locale,java.lang.String> queryName,
                                           AdvancedSearchData advancedSearchData,
                                           UserModel userModel,
                                           java.util.List<UserGroupModel> groups)

Creates saved query from AdvancedSearchInitContext

Parameters:

queryName - query name

userModel - saved query owner BackofficeSavedQueryModel.setQueryOwner(UserModel)

groups - user groups which should see saved query.

advancedSearchData - advanced search data.

Returns:

saved query model.

getAdvancedSearchInitContext

AdvancedSearchInitContext getAdvancedSearchInitContext(BackofficeSavedQueryModel savedQueryModel)

Converts saved query model to advanced search context which can be passes to advancedSearchWidget. Not convert attributes values are stored in returned object under attribute with a key NOT_CONVERTED_ATTRIBUTE_VALUES

Parameters:

savedQueryModel - saved query.

Returns:

search init context.