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

Class AbstractProductConfigController

java.lang.Object

AbstractPageController

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

Direct Known Subclasses:

AddConfigToCartController, CartConfigureProductController, ConfigurationOverviewController, ConfigureProductController, UpdateConfigureProductController, VariantOverviewController

public abstract class AbstractProductConfigController
extends AbstractPageController

Abstract base class for all CPQ UI controllers.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADDON_PREFIX
static String	AJAX_SUFFIX
static String	CONFIG_ERROR_ROOT
static String	CONFIG_PAGE_ROOT
static String	CONFIGURATOR_TYPE
static String	LOG_CONFIG_DATA
static String	LOG_URL
static String	OVERVIEW_PAGE_ROOT
static String	PRODUCT_ATTRIBUTE
protected UiStateHandler	uiStateHandler
protected UiStatusSync	uiStatusSync

Constructor Summary

Constructors

Constructor and Description
AbstractProductConfigController()

Method Summary

Modifier and Type	Method and Description
protected void	cleanUpSessionAttribute(String baseProduct)
protected KBKeyData	createKBKeyForProduct(ProductData productData)
protected BindingResult	getBindingResultForConfig(ConfigurationData configData, UiStatus uiStatus)
protected ProductConfigureBreadcrumbBuilder	getBreadcrumbBuilder()
protected Integer	getCartEntryNumber(KBKeyData kbKey)
protected ConfigurationCartIntegrationFacade	getConfigCartFacade()
protected ConfigurationData	getConfigData(KBKeyData kbKey, String configId)
protected ConfigurationFacade	getConfigFacade()
protected List<Map<String,ImageData>>	getGalleryImages(ProductData productData)
protected OrderEntryData	getOrderEntry(int entryNumber, CartData cart)
protected AbstractPageModel	getPageForProduct()
protected ConflictChecker	getProductConfigurationConflictChecker()
protected Validator	getProductConfigurationValidator()
protected ProductData	getProductDataForProductCode(String productCode)
protected ProductFacade	getProductFacade()
protected ProductService	getProductService()
protected SessionAccessFacade	getSessionAccessFacade()
protected UiTrackingRecorder	getUiRecorder()
protected void	handleRequestContext(HttpServletRequest request, String productCode)
protected void	ifProductVariant(HttpServletRequest request, Model model, ProductData productData, KBKeyData kbKey)
protected void	initBinder(WebDataBinder binder)
protected boolean	isProductVariant(ProductData productData)
protected ConfigurationData	loadNewConfiguration(KBKeyData kbKey, ProductData productData, String cartItemHandle) Creates a new configuration session.
protected void	logConfigurationCheckDeviation(BindingResult errors, ConfigurationData configData) The ConflictChecker checks only visible characteristics for consistency and completeness as only those characteristics might be changed by the user. If the model is modeled in a way that a conflict appears for an invisible characteristic or an invisible characteristic is mandatory but not filled this would not be identified by those checks but the overall configuration status is not consistent/complete.
protected void	logModelmetaData(ConfigurationData configData)
protected void	logRequestMetaData(ConfigurationData configData, HttpServletRequest request)
protected void	populateProductData(ProductData productData, Model model)
protected ProductData	populateProductData(String productCode, Model model, HttpServletRequest request)
protected ProductData	populateProductDetailForDisplay(String productCode, Model model)
protected ConfigurationData	reloadConfiguration(KBKeyData kbKey, String configId, UiStatus uiStatus)
protected void	removeNullCstics(List<UiGroupData> groups)
protected void	removeNullCsticsFromGroup(List<CsticData> dirtyList)
void	setBreadcrumbBuilder(ProductConfigureBreadcrumbBuilder productConfigurationBreadcrumbBuilder)
protected void	setCartItemPk(ConfigurationData configData)
void	setConfigCartFacade(ConfigurationCartIntegrationFacade configCartFacade)
void	setConfigFacade(ConfigurationFacade configFacade)
void	setProductConfigurationConflictChecker(ConflictChecker productConfigurationConflictChecker)
void	setProductConfigurationValidator(Validator productConfigurationValidator)
void	setProductFacade(ProductFacade productFacade)
void	setProductService(ProductService productService)
void	setSessionAccessFacade(SessionAccessFacade sessionAccessFacade)
void	setUiRecorder(UiTrackingRecorder uiRecorder)
protected void	updatePageTitle(String productCode, Model model)

Methods inherited from class java.lang.Object

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

Field Detail

LOG_URL

public static final String LOG_URL

See Also:

Constant Field Values

ADDON_PREFIX

public static final String ADDON_PREFIX

See Also:

Constant Field Values

PRODUCT_ATTRIBUTE

public static final String PRODUCT_ATTRIBUTE

See Also:

Constant Field Values

LOG_CONFIG_DATA

public static final String LOG_CONFIG_DATA

See Also:

Constant Field Values

CONFIGURATOR_TYPE

public static final String CONFIGURATOR_TYPE

See Also:

Constant Field Values

CONFIG_PAGE_ROOT

public static final String CONFIG_PAGE_ROOT

See Also:

Constant Field Values

CONFIG_ERROR_ROOT

public static final String CONFIG_ERROR_ROOT

See Also:

Constant Field Values

OVERVIEW_PAGE_ROOT

public static final String OVERVIEW_PAGE_ROOT

See Also:

Constant Field Values

AJAX_SUFFIX

public static final String AJAX_SUFFIX

See Also:

Constant Field Values

uiStatusSync

protected final UiStatusSync uiStatusSync

uiStateHandler

protected final UiStateHandler uiStateHandler

Constructor Detail

AbstractProductConfigController

public AbstractProductConfigController()

Method Detail

initBinder

protected void initBinder(WebDataBinder binder)

getBindingResultForConfig

protected BindingResult getBindingResultForConfig(ConfigurationData configData,
                                                  UiStatus uiStatus)

logConfigurationCheckDeviation

protected void logConfigurationCheckDeviation(BindingResult errors,
                                              ConfigurationData configData)

The ConflictChecker checks only visible characteristics for consistency and completeness as only those characteristics might be changed by the user.

If the model is modeled in a way that a conflict appears for an invisible characteristic or an invisible characteristic is mandatory but not filled this would not be identified by those checks but the overall configuration status is not consistent/complete. This leads to a situation where the configuration cannot be sent to the backend system.

In this case the modeler needs to improve the model to avoid such situations. The user cannot do anything about this so this is only logged as an error as a hint for the modeler.

setCartItemPk

protected void setCartItemPk(ConfigurationData configData)

getCartEntryNumber

protected Integer getCartEntryNumber(KBKeyData kbKey)

loadNewConfiguration

protected ConfigurationData loadNewConfiguration(KBKeyData kbKey,
                                                 ProductData productData,
                                                 String cartItemHandle)

Creates a new configuration session. Either returns a default configuration or creates a configuration from the external configuration attached to a cart entry.
Stores a new UIStatus based on the new configuration in the session (per product).

Returns:

Null if no configuration could be created

reloadConfiguration

protected ConfigurationData reloadConfiguration(KBKeyData kbKey,
                                                String configId,
                                                UiStatus uiStatus)

getConfigData

protected ConfigurationData getConfigData(KBKeyData kbKey,
                                          String configId)

populateProductData

protected ProductData populateProductData(String productCode,
                                          Model model,
                                          HttpServletRequest request)
                                   throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

populateProductDetailForDisplay

protected ProductData populateProductDetailForDisplay(String productCode,
                                                      Model model)
                                               throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

getProductDataForProductCode

protected ProductData getProductDataForProductCode(String productCode)

populateProductData

protected void populateProductData(ProductData productData,
                                   Model model)

getGalleryImages

protected List<Map<String,ImageData>> getGalleryImages(ProductData productData)

isProductVariant

protected boolean isProductVariant(ProductData productData)

ifProductVariant

protected void ifProductVariant(HttpServletRequest request,
                                Model model,
                                ProductData productData,
                                KBKeyData kbKey)
                         throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

cleanUpSessionAttribute

protected void cleanUpSessionAttribute(String baseProduct)

getPageForProduct

protected AbstractPageModel getPageForProduct()
                                       throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

createKBKeyForProduct

protected KBKeyData createKBKeyForProduct(ProductData productData)

removeNullCsticsFromGroup

protected void removeNullCsticsFromGroup(List<CsticData> dirtyList)

removeNullCstics

protected void removeNullCstics(List<UiGroupData> groups)

handleRequestContext

protected void handleRequestContext(HttpServletRequest request,
                                    String productCode)

logModelmetaData

protected void logModelmetaData(ConfigurationData configData)

logRequestMetaData

protected void logRequestMetaData(ConfigurationData configData,
                                  HttpServletRequest request)

updatePageTitle

protected void updatePageTitle(String productCode,
                               Model model)

getConfigFacade

protected ConfigurationFacade getConfigFacade()

getConfigCartFacade

protected ConfigurationCartIntegrationFacade getConfigCartFacade()

getSessionAccessFacade

protected SessionAccessFacade getSessionAccessFacade()

getProductConfigurationValidator

protected Validator getProductConfigurationValidator()

getProductConfigurationConflictChecker

protected ConflictChecker getProductConfigurationConflictChecker()

getProductFacade

protected ProductFacade getProductFacade()

getProductService

protected ProductService getProductService()

getOrderEntry

protected OrderEntryData getOrderEntry(int entryNumber,
                                       CartData cart)
                                throws CommerceCartModificationException

Throws:

CommerceCartModificationException

getBreadcrumbBuilder

protected ProductConfigureBreadcrumbBuilder getBreadcrumbBuilder()

setConfigFacade

public void setConfigFacade(ConfigurationFacade configFacade)

Parameters:

configFacade - CPQ facade

setConfigCartFacade

public void setConfigCartFacade(ConfigurationCartIntegrationFacade configCartFacade)

Parameters:

configCartFacade - CPQ cart integration facade

setSessionAccessFacade

public void setSessionAccessFacade(SessionAccessFacade sessionAccessFacade)

Parameters:

sessionAccessFacade - CPQ session cache access

setProductConfigurationValidator

public void setProductConfigurationValidator(Validator productConfigurationValidator)

Parameters:

productConfigurationValidator - CPQ validator

setProductConfigurationConflictChecker

public void setProductConfigurationConflictChecker(ConflictChecker productConfigurationConflictChecker)

Parameters:

productConfigurationConflictChecker - status and UI error handling&checking

setProductFacade

public void setProductFacade(ProductFacade productFacade)

Parameters:

productFacade - for accessing product master data

setProductService

public void setProductService(ProductService productService)

Parameters:

productService - for accessing product related service

setBreadcrumbBuilder

public void setBreadcrumbBuilder(ProductConfigureBreadcrumbBuilder productConfigurationBreadcrumbBuilder)

Parameters:

productConfigurationBreadcrumbBuilder - for building UI breadcrumbs

getUiRecorder

protected UiTrackingRecorder getUiRecorder()

setUiRecorder

public void setUiRecorder(UiTrackingRecorder uiRecorder)

Parameters:

uiRecorder - triggering CPQ tracking