de.hybris.platform.commercesearch.searchandizing.boost

Interface BoostFacade

All Known Implementing Classes:

DefaultBoostFacade

public interface BoostFacade

Facade interface for retrieving product boost rule settings.

Method Summary

Modifier and Type	Method and Description
BoostRuleData	createBoostRule(String categoryCode, BoostRuleData boostRuleData) Creates a new boost rule for a given category and propertyName.
String	getBoostProfileCategoryId(String categoryId) Returns the search profile category id for a given category id.
String	getBoostProfileCategoryName(String categoryId) Returns the search profile category name for a given category id.
Collection<BoostRuleData>	getBoostRules(String categoryId) Returns all boost rule settings for a given category.
SearchProfileData	getSearchProfileData(String categoryCode) Returns search profile data for a given category.

Method Detail

getBoostRules

Collection<BoostRuleData> getBoostRules(String categoryId)

Returns all boost rule settings for a given category.

Parameters:

categoryId - The category code (leave null to retrieve global boosts)

Returns:

All found BoostRuleData or an empty collection if no BoostRuleData exists for that category

getBoostProfileCategoryId

String getBoostProfileCategoryId(String categoryId)

Returns the search profile category id for a given category id.

Parameters:

categoryId - The category code

Returns:

The category id of the found search profile

getBoostProfileCategoryName

String getBoostProfileCategoryName(String categoryId)

Returns the search profile category name for a given category id.

Parameters:

categoryId - The category code

Returns:

The category name of the found search profile

createBoostRule

BoostRuleData createBoostRule(String categoryCode,
                              BoostRuleData boostRuleData)

Creates a new boost rule for a given category and propertyName. The propertyName should be provided in boostRuleData and should match with propertyName from indexed property.

Parameters:

categoryCode - Category code for which the boost rule should be created. The new boost rule will be assigned to the relevant search profile. If categoryCode is null then the new boost rule will be assigned to the global search profile.

boostRuleData - BoostRuleData contains information's like operatorType, boostFactor, propertyName and propertyValue which are used to create a new boost rule

Returns:

The new created boost rule.

getSearchProfileData

SearchProfileData getSearchProfileData(String categoryCode)

Returns search profile data for a given category.

Parameters:

categoryCode - The category code the profile of which is being looked for.

Returns:

Search profile data for the category