Package de.hybris.platform.sap.productconfig.frontend.controllers

Class AbstractConfigurationOverviewController

java.lang.Object

de.hybris.platform.acceleratorstorefrontcommons.controllers.AbstractController

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

de.hybris.platform.sap.productconfig.frontend.controllers.AbstractProductConfigController

de.hybris.platform.sap.productconfig.frontend.controllers.AbstractConfigurationOverviewController

Direct Known Subclasses:

ConfigurationOverviewController, OrderEntryOverviewController, VariantOverviewController

public class AbstractConfigurationOverviewController
extends AbstractProductConfigController

Abstract base class for all controllers of the Product Configuration Overview Page.
The Overview page can be shown in different contexts, for each of them an own controller implementation exists. For example:

• Cart - ConfigurationOverviewController
• Order - OrderEntryOverviewController
• Variants - VariantOverviewController

Nested Class Summary

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[]	ALLOWED_FIELDS_OVERVIEWUIDATA
protected static final String	CMS_OV_PAGE_ID
protected static final String	CMS_OV_PAGE_TYPE

Fields inherited from class de.hybris.platform.sap.productconfig.frontend.controllers.AbstractProductConfigController

CMS_PAGE_TYPE, CMS_PC_PAGE_ID, CMS_PC_PAGE_TYPE

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
AbstractConfigurationOverviewController()

Method Summary

Modifier and Type	Method	Description
protected void	addBreadCrumb(org.springframework.ui.Model model, ProductData productData, OverviewUiData overviewUiData)
protected List<FilterData>	computeUiGroupFilterList(List<FilterData> maxUiGroups)
protected List<FilterData>	generateCsticFilterDataList(ConfigurationOverviewData configOverviewData)
protected String	getCartItemPk(String abstractOrderCode, int intValue)
ConfigErrorHandler	getConfigurationErrorHandler()
protected ConfigurationOverviewFacade	getConfigurationOverviewFacade()
protected Object	getErrorCountForUi(int errorCount)
protected OrderFacade	getOrderFacade()
protected String	getOrderItemPk(String orderCode, int orderEntryNumber)
protected String	getPageId()
protected String	getPageType()
protected long	getQuantity(String baseProduct)
protected QuoteFacade	getQuoteFacade()
protected String	getQuoteItemPk(String quoteCode, int quoteEntryNumber)
SaveCartFacade	getSaveCartFacade()
protected UiStatus	getUiStatusForOverview(String cartEntryKey, OverviewUiData overviewUiData)
void	initBinderConfigOverviewUiData(org.springframework.web.bind.WebDataBinder binder)	A HTTP-Client is an untrusted source, hence we provide a white list of form-fields, which we accept from the HTTP-Client.
protected void	initializeFilterListsInUiStatus(ConfigurationOverviewData configOverviewData, UiStatus uiStatus)
protected List<FilterData>	initializeGroupFilterDataList(ConfigurationOverviewData configOverviewData)
protected boolean	needConfigurationDetails(OverviewUiData overviewUiData)
protected void	prepareOverviewUiData(OverviewUiData overviewUiData, ConfigurationOverviewData configOverviewData, ProductData productData)
protected void	prepareOverviewUiData(UiStatus uiStatus, OverviewUiData overviewUiData, ConfigurationOverviewData configOverviewData, KBKeyData kbKey)
protected void	prepareUiModel(javax.servlet.http.HttpServletRequest request, org.springframework.ui.Model model, OverviewUiData overviewUiData, ConfigurationOverviewData configOverviewData)
protected void	prepareUiModel(javax.servlet.http.HttpServletRequest request, org.springframework.ui.Model model, UiStatus uiStatus, OverviewUiData overviewUiData, ConfigurationOverviewData configOverviewData)
void	setConfigurationErrorHandler(ConfigErrorHandler configurationErrorHandler)
void	setConfigurationOverviewFacade(ConfigurationOverviewFacade configurationOverviewFacade)
void	setOrderFacade(OrderFacade orderFacade)
void	setQuoteFacade(QuoteFacade quoteFacade)
void	setSaveCartFacade(SaveCartFacade saveCartFacade)
protected void	setUiStatusForOverviewInSession(UiStatus uiStatus, String cartEntryKey, OverviewUiData overviewUiData)
protected void	updateUiStatusForOverviewInSession(String cartEntryKey, UiStatus uiStatus, OverviewUiData overviewUIData)

Methods inherited from class de.hybris.platform.sap.productconfig.frontend.controllers.AbstractProductConfigController

afterReloadConfiguration, cleanUpSessionAttribute, getAbstractOrderEntryLinkStrategy, getBindingResultForConfigAndSaveUiStatus, getBindingResultForConfiguration, getBreadcrumbBuilder, getCartEntryNumber, getCartEntryNumber, getCartFacade, getCartItemByConfigId, getCartItemByProductCode, getConfigCartFacade, getConfigFacade, getGalleryImages, getOrderEntry, getOrderEntry, getProductCodeForCartItem, getProductConfigurationConflictChecker, getProductConfigurationValidator, getProductDataForProductCode, getProductFacade, getProductLinkStrategy, getProductService, getSessionAccessFacade, getSessionId, getUiRecorder, getUiStateHandler, getUiStatusForConfig, getUiStatusForConfigId, getUiStatusSync, handleRequestContext, initBinderConfigData, initializeUiStatus, isConfigLinkedToCart, isConfigRemoved, loadNewConfiguration, logConfigurationCheckDeviation, logLoadConfig, logModelmetaData, logRequestMetaData, populateCMSAttributes, populateProductData, populateProductData, populateProductDetailForDisplay, reloadConfigurationById, reloadConfigurationByKBKey, removeNullCstics, removeNullCsticsFromGroup, setAbstractOrderEntryLinkStrategy, setBreadcrumbBuilder, setCartEntryLinks, setCartFacade, setConfigCartFacade, setConfigFacade, setProductConfigurationConflictChecker, setProductConfigurationValidator, setProductFacade, setProductLinkStrategy, setProductService, setSessionAccessFacade, setUiRecorder, setUiStateHandler, setUiStatusForConfig, setUiStatusSync, updatePageTitle

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

CMS_OV_PAGE_TYPE

protected static final String CMS_OV_PAGE_TYPE

See Also:

• Constant Field Values

CMS_OV_PAGE_ID

protected static final String CMS_OV_PAGE_ID

See Also:

• Constant Field Values

ALLOWED_FIELDS_OVERVIEWUIDATA

protected static final String[] ALLOWED_FIELDS_OVERVIEWUIDATA

Constructor Details

AbstractConfigurationOverviewController

public AbstractConfigurationOverviewController()

Method Details

initBinderConfigOverviewUiData

@InitBinder("overviewUiData")
public void initBinderConfigOverviewUiData(org.springframework.web.bind.WebDataBinder binder)

A HTTP-Client is an untrusted source, hence we provide a white list of form-fields, which we accept from the HTTP-Client.

Parameters:

binder -

prepareOverviewUiData

protected void prepareOverviewUiData(UiStatus uiStatus,
 OverviewUiData overviewUiData,
 ConfigurationOverviewData configOverviewData,
 KBKeyData kbKey)
                              throws BusinessException

Throws:

BusinessException

prepareOverviewUiData

protected void prepareOverviewUiData(OverviewUiData overviewUiData,
 ConfigurationOverviewData configOverviewData,
 ProductData productData)

getQuantity

protected long getQuantity(String baseProduct)

computeUiGroupFilterList

protected List<FilterData> computeUiGroupFilterList(List<FilterData> maxUiGroups)

generateCsticFilterDataList

protected List<FilterData> generateCsticFilterDataList(ConfigurationOverviewData configOverviewData)

getPageId

protected String getPageId()

Overrides:

getPageId in class AbstractProductConfigController

getPageType

protected String getPageType()

Overrides:

getPageType in class AbstractProductConfigController

getConfigurationOverviewFacade

protected ConfigurationOverviewFacade getConfigurationOverviewFacade()

setConfigurationOverviewFacade

public void setConfigurationOverviewFacade(ConfigurationOverviewFacade configurationOverviewFacade)

Parameters:

configurationOverviewFacade - injects the facade for the variant overview

prepareUiModel

protected void prepareUiModel(javax.servlet.http.HttpServletRequest request,
 org.springframework.ui.Model model,
 UiStatus uiStatus,
 OverviewUiData overviewUiData,
 ConfigurationOverviewData configOverviewData)
                       throws BusinessException

Throws:

BusinessException

needConfigurationDetails

protected boolean needConfigurationDetails(OverviewUiData overviewUiData)

getErrorCountForUi

protected Object getErrorCountForUi(int errorCount)

prepareUiModel

protected void prepareUiModel(javax.servlet.http.HttpServletRequest request,
 org.springframework.ui.Model model,
 OverviewUiData overviewUiData,
 ConfigurationOverviewData configOverviewData)
                       throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

addBreadCrumb

protected void addBreadCrumb(org.springframework.ui.Model model,
 ProductData productData,
 OverviewUiData overviewUiData)

updateUiStatusForOverviewInSession

protected void updateUiStatusForOverviewInSession(String cartEntryKey,
 UiStatus uiStatus,
 OverviewUiData overviewUIData)
                                           throws BusinessException

Throws:

BusinessException

initializeGroupFilterDataList

protected List<FilterData> initializeGroupFilterDataList(ConfigurationOverviewData configOverviewData)

initializeFilterListsInUiStatus

protected void initializeFilterListsInUiStatus(ConfigurationOverviewData configOverviewData,
 UiStatus uiStatus)

getQuoteItemPk

protected String getQuoteItemPk(String quoteCode,
 int quoteEntryNumber)
                         throws BusinessException

Throws:

BusinessException

getOrderItemPk

protected String getOrderItemPk(String orderCode,
 int orderEntryNumber)
                         throws BusinessException

Throws:

BusinessException

setUiStatusForOverviewInSession

protected void setUiStatusForOverviewInSession(UiStatus uiStatus,
 String cartEntryKey,
 OverviewUiData overviewUiData)
                                        throws BusinessException

Throws:

BusinessException

getUiStatusForOverview

protected UiStatus getUiStatusForOverview(String cartEntryKey,
 OverviewUiData overviewUiData)
                                   throws BusinessException

Throws:

BusinessException

getCartItemPk

protected String getCartItemPk(String abstractOrderCode,
 int intValue)
                        throws BusinessException

Throws:

BusinessException

getQuoteFacade

protected QuoteFacade getQuoteFacade()

setQuoteFacade

public void setQuoteFacade(QuoteFacade quoteFacade)

Parameters:

quoteFacade - quotation facade

getOrderFacade

protected OrderFacade getOrderFacade()

setOrderFacade

public void setOrderFacade(OrderFacade orderFacade)

Parameters:

orderFacade - order facade

getConfigurationErrorHandler

public ConfigErrorHandler getConfigurationErrorHandler()

Overrides:

getConfigurationErrorHandler in class AbstractProductConfigController

Returns:

configuration error handler

setConfigurationErrorHandler

public void setConfigurationErrorHandler(ConfigErrorHandler configurationErrorHandler)

Overrides:

setConfigurationErrorHandler in class AbstractProductConfigController

Parameters:

configurationErrorHandler - for handling configuration errors

getSaveCartFacade

public SaveCartFacade getSaveCartFacade()

Returns:

the saveCartFacade

setSaveCartFacade

public void setSaveCartFacade(SaveCartFacade saveCartFacade)

Parameters:

saveCartFacade - the saveCartFacade to set