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 java.lang.String	PRODUCT_CONFIG_SESSION_ATTRIBUTE_CONTAINER cache key of product configuration cache container

Method Summary

Modifier and Type	Method and Description
AnalyticsDocument	getAnalyticData(java.lang.String configId) Retrieves analytic data from the cached map
AnalyticsProvider	getAnalyticsProvider() Retrieves an analytics provider from the cached map
java.util.Map<java.lang.String,ClassificationSystemCPQAttributesContainer>	getCachedNameMap()
java.lang.String	getCartEntryForConfigId(java.lang.String configId) Retrieves cart entry key belonging to a specific config ID
java.lang.String	getCartEntryForProduct(java.lang.String productKey) Retrieves cart entry key per product
java.lang.String	getConfigIdForCartEntry(java.lang.String cartEntryKey) Retrieves config identifier from the session for a given cart entry key
ConfigModel	getConfigurationModelEngineState(java.lang.String configId) Retrieves the configuration model engine state
ConfigurationProvider	getConfigurationProvider() get the configuration provider for this session
PriceSummaryModel	getPriceSummaryState(java.lang.String configId) Retrieves the price summary for a given runtime configuration, specified via its runtime id
PricingConfigurationParameter	getPricingConfigurationParameter() get the pricing parameter for this session
PricingProvider	getPricingProvider() get the pricing provider for this session
java.lang.String	getSessionId() returns the unique session id
java.util.Set<java.lang.String>	getSolrIndexedProperties()
<T> T	getUiStatusForCartEntry(java.lang.String cartEntryKey) Retrieves object from the session for a given cart entry key
<T> T	getUiStatusForProduct(java.lang.String productKey) Retrieves object from the session for a given cart entry key
void	purge() Purges the entire session (with regards to CPQ artifacts)
void	removeCartEntryForProduct(java.lang.String productKey) Removes cart entry key for product
void	removeConfigAttributeState(java.lang.String configId) Removes the given configuration engine state and price summary model from read cache for engine state
void	removeConfigAttributeStates() Clears the read cache for the configuration engine state and price summary states for the whole user session
void	removeConfigIdForCartEntry(java.lang.String cartEntryKey) Removes config ID for cart entry
void	removeSessionArtifactsForCartEntry(java.lang.String cartEntryId, java.lang.String productKey) Removes all session artifacts belonging to a cart entry
void	removeUiStatusForCartEntry(java.lang.String cartEntryKey) Removes object for a cart entry
void	removeUiStatusForProduct(java.lang.String productKey) Removes object for a product
void	setAnalyticData(java.lang.String configId, AnalyticsDocument analyticsDocument) Sets analytic data into the cached map
void	setAnalyticsProvider(AnalyticsProvider analyticsProvider) Puts the given analytics provider into the cached
void	setCartEntryForProduct(java.lang.String productKey, java.lang.String cartEntryId) Stores cart entry in session per product key
void	setConfigIdForCartEntry(java.lang.String cartEntryKey, java.lang.String configId) Stores configuration ID for a cart entry key into the session
void	setConfigurationModelEngineState(java.lang.String configId, ConfigModel configModel) Puts the given config model into the engine state read cache
void	setConfigurationProvider(ConfigurationProvider provider) cache the pricing provider in this session
void	setPriceSummaryState(java.lang.String configId, PriceSummaryModel priceSummaryModel) Puts the given price summary model into the price summary model state read cache
void	setPricingConfigurationParameter(PricingConfigurationParameter pricinParameter) cache the pricing parameter in this session
void	setPricingProvider(PricingProvider provider) cache the pricing provider in this session
void	setSolrIndexedProperties(java.util.Set<java.lang.String> solrTypes) Stores set of indexed properties
void	setUiStatusForCartEntry(java.lang.String cartEntryKey, java.lang.Object uiStatus) Stores object for a cart entry key into the session
void	setUiStatusForProduct(java.lang.String productKey, java.lang.Object uiStatus) Stores object for a product key into the session

Field Detail

PRODUCT_CONFIG_SESSION_ATTRIBUTE_CONTAINER

static final java.lang.String PRODUCT_CONFIG_SESSION_ATTRIBUTE_CONTAINER

cache key of product configuration cache container

See Also:

Constant Field Values

Method Detail

getSessionId

java.lang.String getSessionId()

returns the unique session id

Returns:

session id

setConfigIdForCartEntry

void setConfigIdForCartEntry(java.lang.String cartEntryKey,
                             java.lang.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

java.lang.String getConfigIdForCartEntry(java.lang.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(java.lang.String cartEntryKey)

Retrieves object from the session for a given cart entry key

Parameters:

cartEntryKey - String representation of the cart entry primary key

Returns:

ui status for cart entry

getUiStatusForProduct

<T> T getUiStatusForProduct(java.lang.String productKey)

Retrieves object from the session for a given cart entry key

Parameters:

productKey - Product key

Returns:

ui status for product

setUiStatusForCartEntry

void setUiStatusForCartEntry(java.lang.String cartEntryKey,
                             java.lang.Object uiStatus)

Stores object for a cart entry key into the session

Parameters:

cartEntryKey - String representation of the cart entry primary key

uiStatus - ui status for cart entry

setUiStatusForProduct

void setUiStatusForProduct(java.lang.String productKey,
                           java.lang.Object uiStatus)

Stores object for a product key into the session

Parameters:

productKey - Product key

uiStatus - ui status for product

removeUiStatusForCartEntry

void removeUiStatusForCartEntry(java.lang.String cartEntryKey)

Removes object for a cart entry

Parameters:

cartEntryKey - String representation of the cart entry primary key

removeUiStatusForProduct

void removeUiStatusForProduct(java.lang.String productKey)

Removes object for a product

Parameters:

productKey - Product key

getCartEntryForConfigId

java.lang.String getCartEntryForConfigId(java.lang.String configId)

Retrieves cart entry key belonging to a specific config ID

Parameters:

configId - id of the configuration

Returns:

String representation of the cart entry primary key

setCartEntryForProduct

void setCartEntryForProduct(java.lang.String productKey,
                            java.lang.String cartEntryId)

Stores cart entry in session per product key

Parameters:

productKey - product key

cartEntryId - String representation of the cart entry primary key

getCartEntryForProduct

java.lang.String getCartEntryForProduct(java.lang.String productKey)

Retrieves cart entry key per product

Parameters:

productKey - product key

Returns:

String representation of the cart entry primary key

removeCartEntryForProduct

void removeCartEntryForProduct(java.lang.String productKey)

Removes cart entry key for product

Parameters:

productKey - product key

removeConfigIdForCartEntry

void removeConfigIdForCartEntry(java.lang.String cartEntryKey)

Removes config ID for cart entry

Parameters:

cartEntryKey - cart entry key

removeSessionArtifactsForCartEntry

void removeSessionArtifactsForCartEntry(java.lang.String cartEntryId,
                                        java.lang.String productKey)

Removes all session artifacts belonging to a cart entry

Parameters:

cartEntryId - cart entry key

productKey - product key

getCachedNameMap

java.util.Map<java.lang.String,ClassificationSystemCPQAttributesContainer> getCachedNameMap()

Returns:

Map of names from the hybris classification system

getSolrIndexedProperties

java.util.Set<java.lang.String> getSolrIndexedProperties()

Returns:

Set of indexed properties

setSolrIndexedProperties

void setSolrIndexedProperties(java.util.Set<java.lang.String> solrTypes)

Stores set of indexed properties

Parameters:

solrTypes - solr types to be stored

getConfigurationProvider

ConfigurationProvider getConfigurationProvider()

get the configuration provider for this session

Returns:

Configuration provider

setPricingProvider

void setPricingProvider(PricingProvider provider)

cache the pricing provider in this session

Parameters:

provider - provider to cache

getPricingProvider

PricingProvider getPricingProvider()

get the pricing provider for this session

Returns:

Configuration provider

setConfigurationProvider

void setConfigurationProvider(ConfigurationProvider provider)

cache the pricing provider in this session

Parameters:

provider - provider to cache

getPricingConfigurationParameter

PricingConfigurationParameter getPricingConfigurationParameter()

get the pricing parameter for this session

Returns:

Pricing Configuration Parameter

setPricingConfigurationParameter

void setPricingConfigurationParameter(PricingConfigurationParameter pricinParameter)

cache the pricing parameter in this session

Parameters:

pricinParameter - provider to cache

getConfigurationModelEngineState

ConfigModel getConfigurationModelEngineState(java.lang.String configId)

Retrieves the configuration model engine state

Parameters:

configId - id of the configuration

Returns:

Configuration model

setConfigurationModelEngineState

void setConfigurationModelEngineState(java.lang.String configId,
                                      ConfigModel configModel)

Puts the given config model into the engine state read cache

Parameters:

configId - unique config id

configModel - model to cache

removeConfigAttributeStates

void removeConfigAttributeStates()

Clears the read cache for the configuration engine state and price summary states for the whole user session

getPriceSummaryState

PriceSummaryModel getPriceSummaryState(java.lang.String configId)

Retrieves the price summary for a given runtime configuration, specified via its runtime id

Parameters:

configId - id of the configuration

Returns:

price summary model

setPriceSummaryState

void setPriceSummaryState(java.lang.String configId,
                          PriceSummaryModel priceSummaryModel)

Puts the given price summary model into the price summary model state read cache

Parameters:

configId - unique config id

priceSummaryModel - model to cache

setAnalyticsProvider

void setAnalyticsProvider(AnalyticsProvider analyticsProvider)

Puts the given analytics provider into the cached

Parameters:

analyticsProvider -

removeConfigAttributeState

void removeConfigAttributeState(java.lang.String configId)

Removes the given configuration engine state and price summary model from read cache for engine state

Parameters:

configId - unique config id

getAnalyticsProvider

AnalyticsProvider getAnalyticsProvider()

Retrieves an analytics provider from the cached map

Returns:

return the cached analytics provider

setAnalyticData

void setAnalyticData(java.lang.String configId,
                     AnalyticsDocument analyticsDocument)

Sets analytic data into the cached map

Parameters:

configId - id of the configuration

analyticsDocument - analytics document to be stored

getAnalyticData

AnalyticsDocument getAnalyticData(java.lang.String configId)

Retrieves analytic data from the cached map

Parameters:

configId - id of the configuration

Returns:

anlytics document

purge

void purge()

Purges the entire session (with regards to CPQ artifacts)