Package de.hybris.platform.acceleratorstorefrontcommons.controllers.pages

Class AbstractCategoryPageController

java.lang.Object

de.hybris.platform.acceleratorstorefrontcommons.controllers.AbstractController

de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractPageController

de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractSearchPageController

de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractCategoryPageController

Direct Known Subclasses:

TmaCategoryPageController

public class AbstractCategoryPageController
extends AbstractSearchPageController

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractCategoryPageController.CategorySearchEvaluator

Nested classes/interfaces inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractSearchPageController

AbstractSearchPageController.SearchResultsData<RESULT>, AbstractSearchPageController.ShowMode

Nested classes/interfaces inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.AbstractController

AbstractController.HttpNotFoundException

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CATEGORY_CODE_PATH_VARIABLE_PATTERN	We use this suffix pattern because of an issue with Spring 3.1 where a Uri value is incorrectly extracted if it contains on or more '.' characters.
protected static final String	PRODUCT_GRID_PAGE

Fields inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractSearchPageController

MAX_PAGE_LIMIT

Fields inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractPageController

CMS_PAGE_MODEL, CMS_PAGE_TITLE, PAGE_ROOT, REDIRECT_TO_LOGIN_FOR_CHECKOUT, REDIRECT_TO_MULTISTEP_CHECKOUT, REGISTRATION_CONSENT_ID, UTF_8

Fields inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.AbstractController

FORWARD_PREFIX, REDIRECT_PREFIX, ROOT

Constructor Summary

Constructors

Constructor	Description
AbstractCategoryPageController()

Method Summary

Modifier and Type	Method	Description
protected boolean	categoryHasDefaultPage(CategoryPageModel categoryPage)
protected ProductCategorySearchPageData<SearchStateData,ProductData,CategoryData>	createEmptySearchResult(String categoryCode)	Creates empty search results in case doSearch throws an exception in order to avoid stacktrace on storefront.
de.hybris.platform.commerceservices.url.UrlResolver<CategoryModel>	getCategoryModelUrlResolver()
protected CategoryPageModel	getCategoryPage(CategoryModel category)
de.hybris.platform.cms2.servicelayer.services.CMSPreviewService	getCMSPreviewService()
de.hybris.platform.commerceservices.category.CommerceCategoryService	getCommerceCategoryService()
de.hybris.platform.acceleratorservices.customer.CustomerLocationService	getCustomerLocationService()
protected CategoryPageModel	getDefaultCategoryPage()
de.hybris.platform.commercefacades.search.ProductSearchFacade<ProductData>	getProductSearchFacade()
SearchBreadcrumbBuilder	getSearchBreadcrumbBuilder()
protected String	getViewPage(CategoryPageModel categoryPage)
String	handleUnknownIdentifierException(de.hybris.platform.servicelayer.exceptions.UnknownIdentifierException exception, javax.servlet.http.HttpServletRequest request)
protected FacetRefinement<SearchStateData>	performSearchAndGetFacets(String categoryCode, String searchQuery, int page, AbstractSearchPageController.ShowMode showMode, String sortCode)
protected AbstractSearchPageController.SearchResultsData<ProductData>	performSearchAndGetResultsData(String categoryCode, String searchQuery, int page, AbstractSearchPageController.ShowMode showMode, String sortCode)
protected String	performSearchAndGetResultsPage(String categoryCode, String searchQuery, int page, AbstractSearchPageController.ShowMode showMode, String sortCode, org.springframework.ui.Model model, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected ProductCategorySearchPageData<SearchStateData,ProductData,CategoryData>	populateSearchPageData(String categoryCode, String searchQuery, int page, AbstractSearchPageController.ShowMode showMode, String sortCode)
protected <QUERY> void	updatePageTitle(CategoryModel category, org.springframework.ui.Model model)

Methods inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractSearchPageController

calculateShowAll, calculateShowPaged, convertBreadcrumbsToFacets, createEmptyPagination, createPageableData, encodeSearchPageData, existsFacetValueWithName, getMaxSearchPageSize, getSearchPageSize, isShowAllAllowed, populateModel, processFacetData, processFacetDatas, refineFacets

Methods inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractPageController

addRegistrationConsentDataToModel, checkRequestUrl, createMetaElement, decodeWithScheme, getBaseSiteService, getCheckoutRedirectUrl, getCmsPageService, getCmsPreviewService, getCmsSiteService, getConfigurationService, getConsentFacade, getContentPageForLabelOrId, getCurrencies, getCurrentCurrency, getCurrentLanguage, getCustomerFacade, getHostConfigService, getI18nService, getLanguages, getMessageSource, getPageTitleResolver, getRequestContextData, getSessionService, getSiteConfigService, getSiteName, getSiteUid, getStoreSessionFacade, getUser, getUserFacade, getViewForPage, getViewForPage, prepareNotFoundPage, setUpMetaData, setUpMetaDataForContentPage, storeCmsPageInModel, storeContentPageTitleInModel, storeContinueUrl, urlEncode

Methods inherited from class de.hybris.platform.acceleratorstorefrontcommons.controllers.AbstractController

addRequestToModel, getBean

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CATEGORY_CODE_PATH_VARIABLE_PATTERN

protected static final String CATEGORY_CODE_PATH_VARIABLE_PATTERN

We use this suffix pattern because of an issue with Spring 3.1 where a Uri value is incorrectly extracted if it contains on or more '.' characters. Please see https://jira.springsource.org/browse/SPR-6164 for a discussion on the issue and future resolution.

See Also:

• Constant Field Values

PRODUCT_GRID_PAGE

protected static final String PRODUCT_GRID_PAGE

See Also:

• Constant Field Values

Constructor Details

AbstractCategoryPageController

public AbstractCategoryPageController()

Method Details

handleUnknownIdentifierException

@ExceptionHandler(de.hybris.platform.servicelayer.exceptions.UnknownIdentifierException.class)
public String handleUnknownIdentifierException(de.hybris.platform.servicelayer.exceptions.UnknownIdentifierException exception,
 javax.servlet.http.HttpServletRequest request)

performSearchAndGetResultsPage

protected String performSearchAndGetResultsPage(String categoryCode,
 String searchQuery,
 int page,
 AbstractSearchPageController.ShowMode showMode,
 String sortCode,
 org.springframework.ui.Model model,
 javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)
                                         throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

createEmptySearchResult

protected ProductCategorySearchPageData<SearchStateData,ProductData,CategoryData> createEmptySearchResult(String categoryCode)

Creates empty search results in case doSearch throws an exception in order to avoid stacktrace on storefront.

Parameters:

categoryCode - category code

Returns:

created ProductCategorySearchPageData

performSearchAndGetFacets

protected FacetRefinement<SearchStateData> performSearchAndGetFacets(String categoryCode,
 String searchQuery,
 int page,
 AbstractSearchPageController.ShowMode showMode,
 String sortCode)

performSearchAndGetResultsData

protected AbstractSearchPageController.SearchResultsData<ProductData> performSearchAndGetResultsData(String categoryCode,
 String searchQuery,
 int page,
 AbstractSearchPageController.ShowMode showMode,
 String sortCode)

populateSearchPageData

protected ProductCategorySearchPageData<SearchStateData,ProductData,CategoryData> populateSearchPageData(String categoryCode,
 String searchQuery,
 int page,
 AbstractSearchPageController.ShowMode showMode,
 String sortCode)

getDefaultCategoryPage

protected CategoryPageModel getDefaultCategoryPage()

categoryHasDefaultPage

protected boolean categoryHasDefaultPage(CategoryPageModel categoryPage)

getCategoryPage

protected CategoryPageModel getCategoryPage(CategoryModel category)

updatePageTitle

protected <QUERY> void updatePageTitle(CategoryModel category,
 org.springframework.ui.Model model)

getViewPage

protected String getViewPage(CategoryPageModel categoryPage)

getProductSearchFacade

public de.hybris.platform.commercefacades.search.ProductSearchFacade<ProductData> getProductSearchFacade()

Returns:

the productSearchFacade

getCommerceCategoryService

public de.hybris.platform.commerceservices.category.CommerceCategoryService getCommerceCategoryService()

Returns:

the commerceCategoryService

getSearchBreadcrumbBuilder

public SearchBreadcrumbBuilder getSearchBreadcrumbBuilder()

Returns:

the searchBreadcrumbBuilder

getCategoryModelUrlResolver

public de.hybris.platform.commerceservices.url.UrlResolver<CategoryModel> getCategoryModelUrlResolver()

Returns:

the categoryModelUrlResolver

getCustomerLocationService

public de.hybris.platform.acceleratorservices.customer.CustomerLocationService getCustomerLocationService()

Returns:

the customerLocationService

getCMSPreviewService

public de.hybris.platform.cms2.servicelayer.services.CMSPreviewService getCMSPreviewService()

Returns:

the cmsPreviewService