Interface ProductConfigurationOrderIntegrationService
-
- All Known Implementing Classes:
ProductConfigurationOrderIntegrationServiceImpl
public interface ProductConfigurationOrderIntegrationServiceFacilitates interaction between configuration, pricing and order entries.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description CartEntryConfigurationAttributescalculateCartEntryConfigurationAttributes(AbstractOrderEntryModel model)Calculates configuration relevant attributes at cart entry levelCartEntryConfigurationAttributescalculateCartEntryConfigurationAttributes(java.lang.String cartEntryKey, java.lang.String productCode, java.lang.String externalConfiguration)Calculates configuration relevant attributes at cart entry levelConfigModelensureConfigurationInSession(java.lang.String cartEntryKey, java.lang.String productCode, java.lang.String externalConfiguration)Deprecated, for removal: This API element is subject to removal in a future version.since 18.08 UseConfigurationAbstractOrderEntryLinkStrategy#getConfigurationForAbstractOrderEntry(AbstractOrderEntryModel)instead
Ensures that configuration is available in sessionvoidfillSummaryMap(AbstractOrderEntryModel entry)Fill the summary map at the order entry with configuration status informationbooleanupdateCartEntryBasePrice(AbstractOrderEntryModel entry)Deprecated, for removal: This API element is subject to removal in a future version.since 18.08 useProductConfigurationStrategy#updateCartEntryBasePrice(AbstractOrderEntryModel)insteadbooleanupdateCartEntryExternalConfiguration(CommerceCartParameter parameters, AbstractOrderEntryModel entry)Updates cart entry's external configuration from configuration modelbooleanupdateCartEntryExternalConfiguration(java.lang.String externalConfiguration, AbstractOrderEntryModel entry)Updates cart entry's external configuration and creates configuration in current session from external string representation (which contains the configuration in XML format)booleanupdateCartEntryPrices(AbstractOrderEntryModel entry, boolean calculateCart, CommerceCartParameter passedParameter)Deprecated, for removal: This API element is subject to removal in a future version.since 18.08 useProductConfigurationStrategy#updateCartEntryPrices(AbstractOrderEntryModel,boolean,CommerceCartParameter)insteadbooleanupdateCartEntryProduct(AbstractOrderEntryModel entry, ProductModel product, java.lang.String configId)Update the product of the cartItem, if the product is different to the current cart item product
-
-
-
Method Detail
-
calculateCartEntryConfigurationAttributes
CartEntryConfigurationAttributes calculateCartEntryConfigurationAttributes(AbstractOrderEntryModel model)
Calculates configuration relevant attributes at cart entry level- Parameters:
model- Cart Entry- Returns:
- attributes relevant for configuration
-
ensureConfigurationInSession
@Deprecated(since="1808", forRemoval=true) ConfigModel ensureConfigurationInSession(java.lang.String cartEntryKey, java.lang.String productCode, java.lang.String externalConfiguration)Deprecated, for removal: This API element is subject to removal in a future version.since 18.08 UseConfigurationAbstractOrderEntryLinkStrategy#getConfigurationForAbstractOrderEntry(AbstractOrderEntryModel)instead
Ensures that configuration is available in session- Parameters:
cartEntryKey- Key of cart entry, derived fromPKproductCode- Product IDexternalConfiguration- External configuration as XML- Returns:
- configuration model
-
calculateCartEntryConfigurationAttributes
CartEntryConfigurationAttributes calculateCartEntryConfigurationAttributes(java.lang.String cartEntryKey, java.lang.String productCode, java.lang.String externalConfiguration)
Calculates configuration relevant attributes at cart entry level- Parameters:
cartEntryKey- Key of cart entry, derived fromPKproductCode- Product IDexternalConfiguration- External configuration as XML- Returns:
- attributes relevant for configuration
-
updateCartEntryExternalConfiguration
boolean updateCartEntryExternalConfiguration(CommerceCartParameter parameters, AbstractOrderEntryModel entry)
Updates cart entry's external configuration from configuration model- Parameters:
parameters- parameters for cartentry- cart entry- Returns:
- true if cart entry has been updated
-
updateCartEntryExternalConfiguration
boolean updateCartEntryExternalConfiguration(java.lang.String externalConfiguration, AbstractOrderEntryModel entry)Updates cart entry's external configuration and creates configuration in current session from external string representation (which contains the configuration in XML format)- Parameters:
externalConfiguration- Configuration as XML stringentry- cart entry- Returns:
- true if cart entry has been updated
-
updateCartEntryProduct
boolean updateCartEntryProduct(AbstractOrderEntryModel entry, ProductModel product, java.lang.String configId)
Update the product of the cartItem, if the product is different to the current cart item product- Parameters:
entry- Entry to change, if necessaryproduct- cart item productconfigId- ID of the current configuration- Returns:
- true if the entry was updated
-
fillSummaryMap
void fillSummaryMap(AbstractOrderEntryModel entry)
Fill the summary map at the order entry with configuration status information- Parameters:
entry- Entry to be enhanced with additional information
-
updateCartEntryBasePrice
@Deprecated(since="1808", forRemoval=true) boolean updateCartEntryBasePrice(AbstractOrderEntryModel entry)Deprecated, for removal: This API element is subject to removal in a future version.since 18.08 useProductConfigurationStrategy#updateCartEntryBasePrice(AbstractOrderEntryModel)insteadUpdates cart entry's base price from configuration model if a price is available in configuration model. ConfigId has to be present in current session for given cart entry to retrieve configuration model. The caller has to take care for triggering recalculate of cart afterwards.- Parameters:
entry- cart entry- Returns:
- true if cart entry has been updated
-
updateCartEntryPrices
@Deprecated(since="1808", forRemoval=true) boolean updateCartEntryPrices(AbstractOrderEntryModel entry, boolean calculateCart, CommerceCartParameter passedParameter)Deprecated, for removal: This API element is subject to removal in a future version.since 18.08 useProductConfigurationStrategy#updateCartEntryPrices(AbstractOrderEntryModel,boolean,CommerceCartParameter)insteadUpdates cart entry's base price (in case it deviates from the current configuration price) from configuration model/pricing service. ConfigId has to be present in current session for given cart entry to retrieve configuration model. This includes recalculation and saving of the cart if entry prices were updated.- Parameters:
entry- cart entrycalculateCart- specifies whether cart is calculated on successful updatepassedParameter- parameters for recalculation of the cart- Returns:
- true if cart entry has been updated
-
-