de.hybris.platform.commercesearch.searchandizing.heroproduct

Interface HeroProductFacade

All Known Implementing Classes:

DefaultHeroProductFacade

public interface HeroProductFacade

This interface should be implemented by a facade that is responsible for managing hero products. Product can be marked as a hero product if it should be displayed on top of result list. Hero product can be defined only for a category (no global hero products available). Facade allows to control hero products by adding/removing/retrieving/setting order of heroes.

Method Summary

Modifier and Type	Method and Description
void	addHeroProduct(String categoryCode, String productCode) Adds the product with the specified product code to the SolrHeroProductDefinitionModel which contains the category with the specified category code.
List<String>	getHeroProductsForCategory(String categoryCode) Retrieves all products that are included in the SolrHeroProductDefinitionModel which is specified by the given category.
void	moveHeroProductDown(String categoryCode, String productCode) Moves the specified product code one position down in the list of (hero) products in the SolrHeroProductDefinitionModel which contains the category with the specified category code.
void	moveHeroProductToPosition(String categoryCode, String productCode, int position) Moves the specified product code to the given position in the list of (hero) products in the SolrHeroProductDefinitionModel which contains the category with the specified category code.
void	moveHeroProductUp(String categoryCode, String productCode) Moves the specified product code one position up in the list of (hero) products in the SolrHeroProductDefinitionModel which contains the category with the specified category code.
void	removeHeroProduct(String categoryCode, String productCode) Removes the product with the specified product code from the SolrHeroProductDefinitionModel which contains the category with the specified category code.

Method Detail

getHeroProductsForCategory

List<String> getHeroProductsForCategory(String categoryCode)

Retrieves all products that are included in the SolrHeroProductDefinitionModel which is specified by the given category.

Parameters:

categoryCode - the category code of the category which is contained by the SolrHeroProductDefinitionModel

Returns:

list of all found product codes

addHeroProduct

void addHeroProduct(String categoryCode,
                    String productCode)

Adds the product with the specified product code to the SolrHeroProductDefinitionModel which contains the category with the specified category code. If no such SolrHeroProductDefinitionModel exists, a new one will be created. If the product has already been added to the SolrHeroProductDefinitionModel, no action will be taken, otherwise the product will be added.

Parameters:

categoryCode - the category code of the category which is contained by the SolrHeroProductDefinitionModel

productCode - the product code of the product to be added to the SolrHeroProductDefinitionModel

removeHeroProduct

void removeHeroProduct(String categoryCode,
                       String productCode)

Removes the product with the specified product code from the SolrHeroProductDefinitionModel which contains the category with the specified category code. If no such SolrHeroProductDefinitionModel exists, no action will be taken. If the SolrHeroProductDefinitionModel doesn't contain the product, no action will be taken, otherwise the product will be removed from the SolrHeroProductDefinitionModel.

Parameters:

categoryCode - the category code of the category which is contained by the SolrHeroProductDefinitionModel

productCode - the product code of the product to be removed from the SolrHeroProductDefinitionModel

moveHeroProductUp

void moveHeroProductUp(String categoryCode,
                       String productCode)

Moves the specified product code one position up in the list of (hero) products in the SolrHeroProductDefinitionModel which contains the category with the specified category code. If no such SolrHeroProductDefinitionModel exists, no action will be taken. If the SolrHeroProductDefinitionModel doesn't contain the product, or if the product is already at the first position, no action will be taken.

Parameters:

categoryCode - the category code of the category which is contained by the SolrHeroProductDefinitionModel

productCode - the product code of the product to be removed from the SolrHeroProductDefinitionModel

moveHeroProductDown

void moveHeroProductDown(String categoryCode,
                         String productCode)

Moves the specified product code one position down in the list of (hero) products in the SolrHeroProductDefinitionModel which contains the category with the specified category code. If no such SolrHeroProductDefinitionModel exists, no action will be taken. If the SolrHeroProductDefinitionModel doesn't contain the product, or if the product is already at the last position, no action will be taken.

Parameters:

categoryCode - the category code of the category which is contained by the SolrHeroProductDefinitionModel

productCode - the product code of the product to be removed from the SolrHeroProductDefinitionModel

moveHeroProductToPosition

void moveHeroProductToPosition(String categoryCode,
                               String productCode,
                               int position)

Moves the specified product code to the given position in the list of (hero) products in the SolrHeroProductDefinitionModel which contains the category with the specified category code. If no such SolrHeroProductDefinitionModel exists, no action will be taken. If the SolrHeroProductDefinitionModel doesn't contain the product, no action will be taken.

Parameters:

categoryCode - the category code of the category which is contained by the SolrHeroProductDefinitionModel

productCode - the product code of the product to be removed from the SolrHeroProductDefinitionModel

position - the position in the list of hero products within the given category, stored in the SolrHeroProductDefinitionModel. 0 is the first position; If the position exceeds the list's length, the product will be added at the end of the list.