Package de.hybris.platform.sap.productconfig.runtime.interf

Interface PricingProvider

All Known Implementing Classes:

CPSPricingProvider, DefaultPricingProviderImpl, DummyPricingProvider

public interface PricingProvider

Provides access to configuration pricing information from the configuration in an asynchronous manner in relation to the configuration process.

Method Summary

Modifier and Type	Method	Description
void	fillValuePrices(ConfigModel configModel)	Fills value prices into the config model
default void	fillValuePrices(ConfigModel configModel, ConfigurationRetrievalOptions options)	Fills value prices into the config model
void	fillValuePrices(java.util.List<PriceValueUpdateModel> updateModels, java.lang.String kbId)	Fills absolute value prices or delta prices for all passed PriceValueUpdateModels dependent on setting in backoffice
default void	fillValuePrices(java.util.List<PriceValueUpdateModel> updateModels, java.lang.String kbId, ConfigurationRetrievalOptions options)	Fills absolute value prices or delta prices for all passed PriceValueUpdateModels dependent on setting in backoffice
PriceSummaryModel	getPriceSummary(java.lang.String configId)	Deprecated, for removal: This API element is subject to removal in a future version. since 18.11.0 - use getPriceSummary(String, ConfigurationRetrievalOptions)
PriceSummaryModel	getPriceSummary(java.lang.String configId, ConfigurationRetrievalOptions options)	Retrieves if present current total price, base price and selected options price
boolean	isActive()	Indicates whether the pricing provider is active

Method Detail

getPriceSummary

@Deprecated(since="1811",
            forRemoval=true)
PriceSummaryModel getPriceSummary(java.lang.String configId)
                           throws PricingEngineException

Deprecated, for removal: This API element is subject to removal in a future version.

since 18.11.0 - use getPriceSummary(String, ConfigurationRetrievalOptions)

Retrieves if present current total price, base price and selected options price

Parameters:

configId - runtime id of the configuration

Returns:

map of current total price, base price and selected options price

Throws:

PricingEngineException

getPriceSummary

PriceSummaryModel getPriceSummary(java.lang.String configId,
                                  ConfigurationRetrievalOptions options)
                           throws PricingEngineException,
                                  ConfigurationEngineException

Retrieves if present current total price, base price and selected options price

Parameters:

configId - runtime id of the configuration

options - configuration retrieval options

Returns:

map of current total price, base price and selected options price

Throws:

PricingEngineException

ConfigurationEngineException

fillValuePrices

void fillValuePrices(java.util.List<PriceValueUpdateModel> updateModels,
                     java.lang.String kbId)
              throws PricingEngineException

Fills absolute value prices or delta prices for all passed PriceValueUpdateModels dependent on setting in backoffice

Parameters:

updateModels - each list entry represents a characteristic for which absolute value prices or delta prices are filled

kbId - KnowledgeBase id belonging to the runtime configuration for which absolute value prices or delta price are calculated

Throws:

PricingEngineException

fillValuePrices

void fillValuePrices(ConfigModel configModel)
              throws PricingEngineException

Fills value prices into the config model

Parameters:

configModel - runtime representation of the configuration

Throws:

PricingEngineException

fillValuePrices

default void fillValuePrices(java.util.List<PriceValueUpdateModel> updateModels,
                             java.lang.String kbId,
                             ConfigurationRetrievalOptions options)
                      throws PricingEngineException

Fills absolute value prices or delta prices for all passed PriceValueUpdateModels dependent on setting in backoffice

Parameters:

updateModels - each list entry represents a characteristic for which absolute value prices or delta prices are filled

kbId - KnowledgeBase id belonging to the runtime configuration for which absolute value prices or delta price are calculated

options - options to consider during price retrival/calculation, such as external requested conditions

Throws:

PricingEngineException

fillValuePrices

default void fillValuePrices(ConfigModel configModel,
                             ConfigurationRetrievalOptions options)
                      throws PricingEngineException

Fills value prices into the config model

Parameters:

configModel - runtime representation of the configuration

options - options to consider during price retrival/calculation, such as external requested conditions

Throws:

PricingEngineException

isActive

boolean isActive()

Indicates whether the pricing provider is active

Returns:

true if pricing provider is active in the implementation