de.hybris.platform.cscockpit.services.promotions

Interface CsPromotionService

All Known Implementing Classes:

DefaultCsPromotionService

public interface CsPromotionService

Interface for the customer service cart promotions service. This service provides the interface to the promotions extension used in the call center.

Method Summary

Modifier and Type	Method and Description
java.util.List<WrappedPromotionResultModel>	getAppliedPromotionResults(AbstractOrderModel cart, boolean includeOrderPromotions, boolean includeProductPromotions) Get the applied order level promotions for the order.
java.util.List<CartLineItem>	getOrderCombinedPromotionsAndEntries(AbstractOrderModel cart) Gets the list of order entries and promotion results for a order.
java.util.List<WrappedPromotionResultModel>	getPotentialOrderPromotionResults(AbstractOrderModel cart) Get the potential order level promotions for the order.
java.util.List<WrappedPromotionModel>	getProductPromotions(ProductModel product, boolean evaluateRestrictions, java.util.Date currentTime) Get the available product promotions for a specific product
boolean	isPromotionServiceAvailable() Test if the promotions extension integration is available
AbstractItemModelReflectionWrapper	unwrapPromotionTypedObject(TypedObject item) Helper method to unwrap a TypedObject that contains a model item that should be reflection wrapped.
java.util.List<TypedObject>	wrapInTypedObjects(java.util.List<? extends AbstractItemModelReflectionWrapper> list) Helper method to convert promotion wrappers into TypedObject

Method Detail

isPromotionServiceAvailable

boolean isPromotionServiceAvailable()

Test if the promotions extension integration is available

Returns:

true if promotions are available

getProductPromotions

java.util.List<WrappedPromotionModel> getProductPromotions(ProductModel product,
                                                           boolean evaluateRestrictions,
                                                           java.util.Date currentTime)

Get the available product promotions for a specific product

Parameters:

product - The product to check

evaluateRestrictions - Flag to enable checking of promotion restrictions (set to true if you don't know)

currentTime - The effective time to evaluate the promotions (can be null for current time)

Returns:

The list of product promotions for the specified product

getPotentialOrderPromotionResults

java.util.List<WrappedPromotionResultModel> getPotentialOrderPromotionResults(AbstractOrderModel cart)

Get the potential order level promotions for the order.

Parameters:

cart - The order

Returns:

The list of potential order level promotion results

getAppliedPromotionResults

java.util.List<WrappedPromotionResultModel> getAppliedPromotionResults(AbstractOrderModel cart,
                                                                       boolean includeOrderPromotions,
                                                                       boolean includeProductPromotions)

Get the applied order level promotions for the order.

Parameters:

cart - The order

includeOrderPromotions - Set to true to include order promotions

includeProductPromotions - Set to true to include product promotions

Returns:

The list of applied order level promotion results

getOrderCombinedPromotionsAndEntries

java.util.List<CartLineItem> getOrderCombinedPromotionsAndEntries(AbstractOrderModel cart)

Gets the list of order entries and promotion results for a order. The results are as follows. For each applied product promotion result all the consumed entries are included before the promotion result itself. For all the remaining entries with potential promotions each entry is included followed by all its potential promotion results. For all the remaining entries not involved in promotions they are appended to the end of the list.

Parameters:

cart - The order

Returns:

The list of CartLineItem

wrapInTypedObjects

java.util.List<TypedObject> wrapInTypedObjects(java.util.List<? extends AbstractItemModelReflectionWrapper> list)

Helper method to convert promotion wrappers into TypedObject

Parameters:

list - The list of wrappers to convert

Returns:

An unmodifiable list of the wrapped typed objects

unwrapPromotionTypedObject

AbstractItemModelReflectionWrapper unwrapPromotionTypedObject(TypedObject item)

Helper method to unwrap a TypedObject that contains a model item that should be reflection wrapped.

Parameters:

item - The TypedObject to unwrap

Returns:

The wrapper around the model item