de.hybris.platform.sap.productconfig.services

Interface SessionAccessService

All Known Implementing Classes:

DummySessionAccessService, SessionAccessServiceImpl

public interface SessionAccessService

Accessing the session to set and read product configuration related entities like UIStatus or runtime configuration ID per cart entry

Field Summary

Fields

Modifier and Type	Field and Description
static String	PRODUCT_CONFIG_SESSION_ATTRIBUTE_CONTAINER

Method Summary

Modifier and Type	Method and Description
Map<String,ClassificationSystemCPQAttributesContainer>	getCachedNameMap()
String	getCartEntryForConfigId(String configId) Retrieves cart entry key belonging to a specific config ID
String	getCartEntryForProduct(String productKey) Retrieves cart entry key per product
String	getConfigIdForCartEntry(String cartEntryKey) Retrieves config identifier from the session for a given cart entry key
ConfigModel	getConfigurationModelEngineState(String configId)
ConfigurationProvider	getConfigurationProvider() get the configuration provider for this session
String	getSessionId() returns the unique session id
Set<String>	getSolrIndexedProperties()
<T> T	getUiStatusForCartEntry(String cartEntryKey) Retrieves object from the session for a given cart entry key
<T> T	getUiStatusForProduct(String productKey) Retrieves object from the session for a given cart entry key
void	removeCartEntryForProduct(String productKey) Removes cart entry key for product
void	removeConfigIdForCartEntry(String cartEntryKey) Removes config ID for cart entry
void	removeConfigurationModelEngineState(String configId) Removes the given configuration from read cache for engine state
void	removeConfigurationModelEngineStates() Clears the read cache for the configuration engine state for the whole user session
void	removeSessionArtifactsForCartEntry(String cartEntryId, String productKey) Removes all session artifacts belonging to a cart entry
void	removeUiStatusForCartEntry(String cartEntryKey) Removes object for a cart entry
void	removeUiStatusForProduct(String productKey) Removes object for a product
void	setCartEntryForProduct(String productKey, String cartEntryId) Stores cart entry in session per product key
void	setConfigIdForCartEntry(String cartEntryKey, String configId) Stores configuration ID for a cart entry key into the session
void	setConfigurationModelEngineState(String configId, ConfigModel configModel) Puts the given config model into the engine state read cache
void	setConfigurationProvider(ConfigurationProvider provider) cache the configuration provider in this session
void	setSolrIndexedProperties(Set<String> solrTypes) Stores set of indexed properties
void	setUiStatusForCartEntry(String cartEntryKey, Object uiStatus) Stores object for a cart entry key into the session
void	setUiStatusForProduct(String productKey, Object uiStatus) Stores object for a product key into the session

Field Detail

PRODUCT_CONFIG_SESSION_ATTRIBUTE_CONTAINER

static final String PRODUCT_CONFIG_SESSION_ATTRIBUTE_CONTAINER

See Also:

Constant Field Values

Method Detail

getSessionId

String getSessionId()

returns the unique session id

Returns:

session id

setConfigIdForCartEntry

void setConfigIdForCartEntry(String cartEntryKey,
                             String configId)

Stores configuration ID for a cart entry key into the session

Parameters:

cartEntryKey - String representation of the cart entry primary key

configId - ID of a runtime configuration object

getConfigIdForCartEntry

String getConfigIdForCartEntry(String cartEntryKey)

Retrieves config identifier from the session for a given cart entry key

Parameters:

cartEntryKey - String representation of the cart entry primary key

Returns:

ID of a runtime configuration object

getUiStatusForCartEntry

<T> T getUiStatusForCartEntry(String cartEntryKey)

Retrieves object from the session for a given cart entry key

Parameters:

cartEntryKey - String representation of the cart entry primary key

Returns:

Object

getUiStatusForProduct

<T> T getUiStatusForProduct(String productKey)

Retrieves object from the session for a given cart entry key

Parameters:

productKey - Product key

Returns:

Object

setUiStatusForCartEntry

void setUiStatusForCartEntry(String cartEntryKey,
                             Object uiStatus)

Stores object for a cart entry key into the session

Parameters:

cartEntryKey - String representation of the cart entry primary key

uiStatus - Object

setUiStatusForProduct

void setUiStatusForProduct(String productKey,
                           Object uiStatus)

Stores object for a product key into the session

Parameters:

productKey - Product key

uiStatus - Object

removeUiStatusForCartEntry

void removeUiStatusForCartEntry(String cartEntryKey)

Removes object for a cart entry

Parameters:

cartEntryKey - String representation of the cart entry primary key

removeUiStatusForProduct

void removeUiStatusForProduct(String productKey)

Removes object for a product

Parameters:

productKey - Product key

getCartEntryForConfigId

String getCartEntryForConfigId(String configId)

Retrieves cart entry key belonging to a specific config ID

Parameters:

configId -

Returns:

String representation of the cart entry primary key

setCartEntryForProduct

void setCartEntryForProduct(String productKey,
                            String cartEntryId)

Stores cart entry in session per product key

Parameters:

productKey -

cartEntryId - String representation of the cart entry primary key

getCartEntryForProduct

String getCartEntryForProduct(String productKey)

Retrieves cart entry key per product

Parameters:

productKey -

Returns:

String representation of the cart entry primary key

removeCartEntryForProduct

void removeCartEntryForProduct(String productKey)

Removes cart entry key for product

Parameters:

productKey -

removeConfigIdForCartEntry

void removeConfigIdForCartEntry(String cartEntryKey)

Removes config ID for cart entry

Parameters:

cartEntryKey -

removeSessionArtifactsForCartEntry

void removeSessionArtifactsForCartEntry(String cartEntryId,
                                        String productKey)

Removes all session artifacts belonging to a cart entry

Parameters:

cartEntryId -

productKey -

getCachedNameMap

Map<String,ClassificationSystemCPQAttributesContainer> getCachedNameMap()

Returns:

Map of names from the hybris classification system

getSolrIndexedProperties

Set<String> getSolrIndexedProperties()

Returns:

Set of indexed properties

setSolrIndexedProperties

void setSolrIndexedProperties(Set<String> solrTypes)

Stores set of indexed properties

Parameters:

solrTypes -

getConfigurationProvider

ConfigurationProvider getConfigurationProvider()

get the configuration provider for this session

Returns:

Configuration provider

setConfigurationProvider

void setConfigurationProvider(ConfigurationProvider provider)

cache the configuration provider in this session

Parameters:

provider - provider to cache

getConfigurationModelEngineState

ConfigModel getConfigurationModelEngineState(String configId)

Parameters:

configId -

Returns:

Configuration model

setConfigurationModelEngineState

void setConfigurationModelEngineState(String configId,
                                      ConfigModel configModel)

Puts the given config model into the engine state read cache

Parameters:

configId - unique config id

configModel - model to cache

removeConfigurationModelEngineState

void removeConfigurationModelEngineState(String configId)

Removes the given configuration from read cache for engine state

Parameters:

configId - unique config id

removeConfigurationModelEngineStates

void removeConfigurationModelEngineStates()

Clears the read cache for the configuration engine state for the whole user session