de.hybris.platform.sap.productconfig.facades

Interface ConfigurationCartIntegrationFacade

All Known Implementing Classes:

ConfigurationCartIntegrationFacadeImpl

public interface ConfigurationCartIntegrationFacade

Facade containing for integration between the shopping cart and configurable products.
Pure configuration related behavior is handled by the ConfigurationFacade.

Method Summary

Modifier and Type	Method and Description
String	addConfigurationToCart(ConfigurationData configuration) Adds the current configuration to shopping cart.
String	copyConfiguration(String configId) Deprecated. use copyConfiguration(String, String) instead
String	copyConfiguration(String configId, String productCode) Copies a configuration.
default AbstractOrderEntryModel	findItemInCartByPK(PK cartItemPk) Searches the session cart for an entry specified by a primary key.
boolean	isItemInCartByKey(String key)
void	resetConfiguration(String configId) Resets the configuration to the initial state
ConfigurationData	restoreConfiguration(KBKeyData kbKey, String cartEntryKey) Restores a configuration from a cart entry specified by its key.

Method Detail

addConfigurationToCart

String addConfigurationToCart(ConfigurationData configuration)
                       throws CommerceCartModificationException

Adds the current configuration to shopping cart. The configuration is attached to the shopping cart item as external configuration, which is an XML-String.

Parameters:

configuration - configuration to add to the shopping cart

Returns:

key/handle to re-identify the item within the session

Throws:

CommerceCartModificationException - in case the update of the cart failed

isItemInCartByKey

boolean isItemInCartByKey(String key)

Parameters:

key - /handle to re-identify the item within the session

Returns:

true, only if the item is in the cart

copyConfiguration

@Deprecated
String copyConfiguration(String configId)

Deprecated. use copyConfiguration(String, String) instead

Copies a configuration. The implementation can decide if a deep copy is needed; if not, the input ID is simply returned.

Parameters:

configId - ID of existing configuration

Returns:

ID of new configuration if a deep copy was performed; input otherwise

copyConfiguration

String copyConfiguration(String configId,
                         String productCode)

Copies a configuration. The implementation can decide if a deep copy is needed; if not, the input ID is simply returned.

Parameters:

configId - ID of existing configuration

productCode - product code of configurable product to be copied

Returns:

ID of new configuration if a deep copy was performed; input otherwise

resetConfiguration

void resetConfiguration(String configId)

Resets the configuration to the initial state

Parameters:

configId -

restoreConfiguration

ConfigurationData restoreConfiguration(KBKeyData kbKey,
                                       String cartEntryKey)

Restores a configuration from a cart entry specified by its key. This is needed if there is no SSC session connected to the cart entry yet.

Parameters:

kbKey -

cartEntryKey -

Returns:

Configuration runtime object. Null if configuration could not be restored

findItemInCartByPK

default AbstractOrderEntryModel findItemInCartByPK(PK cartItemPk)

Searches the session cart for an entry specified by a primary key. In case nothing is found, null is returned.

Parameters:

cartItemPk - Entry key

Returns:

Corresponding order entry model