de.hybris.platform.commercesearch.searchandizing.heroproduct

Interface HeroProductDefinitionService

All Known Implementing Classes:

DefaultHeroProductDefinitionService

public interface HeroProductDefinitionService

This interface should be implemented by a service 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
SolrHeroProductDefinitionModel	createSolrHeroProductDefinition(CategoryModel Category) Retrieves the SolrHeroProductDefinition with the given category.
SolrHeroProductDefinitionModel	createSolrHeroProductDefinition(String CategoryCode) Retrieves the SolrHeroProductDefinition for the category with the given code.
CatalogVersionModel	getCatalogVersion() Retrieves the CatalogVersion which is defined in the current SolrFacetSearchConfig which is also a current active version in the session.
SolrIndexedTypeModel	getIndexedType() Retrieves the SolrIndexedType
SolrFacetSearchConfigModel	getSolrFacetSearchConfig() Retrieves the current SolrFacetSearchConfig
SolrHeroProductDefinitionModel	getSolrHeroProductDefinitionForCategory(CategoryModel category) Retrieves the SolrHeroProductDefinition with the given category.
SolrHeroProductDefinitionModel	getSolrHeroProductDefinitionForCategory(CategoryModel category, SolrIndexedTypeModel indexedType) Retrieves the SolrHeroProductDefinition with the given category and indexedType.
SolrHeroProductDefinitionModel	getSolrHeroProductDefinitionForCategoryCode(String categoryCode) Retrieves the SolrHeroProductDefinition for the category with the given code.

Method Detail

getSolrHeroProductDefinitionForCategoryCode

SolrHeroProductDefinitionModel getSolrHeroProductDefinitionForCategoryCode(String categoryCode)

Retrieves the SolrHeroProductDefinition for the category with the given code.

Parameters:

categoryCode - category code

Returns:

found SolrHeroProductDefinition

getSolrHeroProductDefinitionForCategory

SolrHeroProductDefinitionModel getSolrHeroProductDefinitionForCategory(CategoryModel category)

Retrieves the SolrHeroProductDefinition with the given category.

Parameters:

category - category

Returns:

found SolrHeroProductDefinition

getSolrFacetSearchConfig

SolrFacetSearchConfigModel getSolrFacetSearchConfig()

Retrieves the current SolrFacetSearchConfig

Returns:

found SolrFacetSearchConfig

getCatalogVersion

CatalogVersionModel getCatalogVersion()

Retrieves the CatalogVersion which is defined in the current SolrFacetSearchConfig which is also a current active version in the session.

Returns:

found CatalogVersion

getIndexedType

SolrIndexedTypeModel getIndexedType()

Retrieves the SolrIndexedType

Returns:

found SolrIndexedType

createSolrHeroProductDefinition

SolrHeroProductDefinitionModel createSolrHeroProductDefinition(String CategoryCode)

Retrieves the SolrHeroProductDefinition for the category with the given code.

Parameters:

CategoryCode - category code

Returns:

found SolrHeroProductDefinition

createSolrHeroProductDefinition

SolrHeroProductDefinitionModel createSolrHeroProductDefinition(CategoryModel Category)

Retrieves the SolrHeroProductDefinition with the given category.

Parameters:

Category - category

Returns:

found SolrHeroProductDefinition

getSolrHeroProductDefinitionForCategory

SolrHeroProductDefinitionModel getSolrHeroProductDefinitionForCategory(CategoryModel category,
                                                                       SolrIndexedTypeModel indexedType)

Retrieves the SolrHeroProductDefinition with the given category and indexedType.

Parameters:

category - category

indexedType - indexed type

Returns:

found SolrHeroProductDefinition