de.hybris.platform.couponservices.services.impl

Class DefaultCouponService

java.lang.Object

de.hybris.platform.couponservices.services.impl.DefaultCouponService

All Implemented Interfaces:

CouponService

Direct Known Subclasses:

DefaultCustomerCouponService

public class DefaultCouponService
extends java.lang.Object
implements CouponService

Default CouponService implementation

Constructor Summary

Constructors

Constructor and Description
DefaultCouponService()

Method Summary

Modifier and Type	Method and Description
protected CouponResponse	assertCouponCodeInOrder(java.lang.String couponCode, AbstractOrderModel order)
protected java.util.function.Predicate<java.lang.String>	checkMatch(AbstractCouponModel coupon, java.lang.String couponCode)
protected java.lang.String	clearCouponCode(java.lang.String couponCode)
protected boolean	containsCouponCode(java.lang.String couponCode, AbstractOrderModel order) returns true if the given couponCode is part of the given order
protected BaseSiteService	getBaseSiteService()
protected CalculationService	getCalculationService()
protected CouponCodeGenerationService	getCouponCodeGenerationService()
java.util.Optional<AbstractCouponModel>	getCouponForCode(java.lang.String couponCode) Returns Coupon Model object for a given coupon code
protected CouponManagementService	getCouponManagementService()
protected ModelService	getModelService()
protected java.util.Collection<PromotionGroupModel>	getPromotionGroups()
protected PromotionsService	getPromotionsService()
java.util.Optional<AbstractCouponModel>	getValidatedCouponForCode(java.lang.String couponCode) Returns Coupon Model object for a given coupon code with validation
protected void	recalculateOrder(AbstractOrderModel order) Recalculates the given order and updates the promotions.
CouponResponse	redeemCoupon(java.lang.String couponCode, CartModel cart) Redeem the coupon code associated with the cart.
CouponResponse	redeemCoupon(java.lang.String couponCode, OrderModel order) Create a coupon redemption instance for the coupon redeemed for the order.
protected void	redeemCouponCode(CartModel cart, java.lang.String clearedCouponCode, CouponResponse response)
void	releaseCouponCode(java.lang.String couponCode, AbstractOrderModel order) Release the coupon code from given cart.
protected void	removeCouponAndTriggerCalculation(java.lang.String couponCode, AbstractOrderModel order)
void	setBaseSiteService(BaseSiteService baseSiteService)
void	setCalculationService(CalculationService calculationService)
void	setCouponCodeGenerationService(CouponCodeGenerationService couponCodeGenerationService)
void	setCouponManagementService(CouponManagementService couponManagementService)
void	setModelService(ModelService modelService)
void	setPromotionsService(PromotionsService promotionsService)
CouponResponse	validateCouponCode(java.lang.String couponCode, UserModel user) Validate if provided couponCode is valid.
CouponResponse	verifyCouponCode(java.lang.String couponCode, AbstractOrderModel order) Verify if provided couponCode is valid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultCouponService

public DefaultCouponService()

Method Detail

verifyCouponCode

public CouponResponse verifyCouponCode(java.lang.String couponCode,
                                       AbstractOrderModel order)

Description copied from interface: CouponService

Verify if provided couponCode is valid.

Specified by:

verifyCouponCode in interface CouponService

Parameters:

couponCode - coupon code to validate

order - order for which coupon should be validated

Returns:

CouponResponse containing true if coupon code is valid or false if not.

validateCouponCode

public CouponResponse validateCouponCode(java.lang.String couponCode,
                                         UserModel user)

Description copied from interface: CouponService

Validate if provided couponCode is valid.

Specified by:

validateCouponCode in interface CouponService

Parameters:

couponCode - coupon code to validate

user - user for which coupon should be validated

Returns:

CouponResponse containing true if coupon code is valid or false if not.

redeemCoupon

public CouponResponse redeemCoupon(java.lang.String couponCode,
                                   CartModel cart)

Description copied from interface: CouponService

Redeem the coupon code associated with the cart.

Specified by:

redeemCoupon in interface CouponService

Parameters:

couponCode - Coupon code to redeem

cart - CartModel to redeem coupon

Returns:

CouponResponse containing true if coupon code has been redeem at cart or false if not.

redeemCouponCode

protected void redeemCouponCode(CartModel cart,
                                java.lang.String clearedCouponCode,
                                CouponResponse response)

redeemCoupon

public CouponResponse redeemCoupon(java.lang.String couponCode,
                                   OrderModel order)

Description copied from interface: CouponService

Create a coupon redemption instance for the coupon redeemed for the order.

Specified by:

redeemCoupon in interface CouponService

Parameters:

couponCode - Coupon code to redeem

order - OrderModel to redeem coupon

Returns:

CouponResponse containing true when coupon redemption instance has been created if a coupon has been redeemed successfully.

clearCouponCode

protected java.lang.String clearCouponCode(java.lang.String couponCode)

assertCouponCodeInOrder

protected CouponResponse assertCouponCodeInOrder(java.lang.String couponCode,
                                                 AbstractOrderModel order)

containsCouponCode

protected boolean containsCouponCode(java.lang.String couponCode,
                                     AbstractOrderModel order)

returns true if the given couponCode is part of the given order

Parameters:

couponCode - the couponCode to check

order - the abstract order to check

checkMatch

protected java.util.function.Predicate<java.lang.String> checkMatch(AbstractCouponModel coupon,
                                                                    java.lang.String couponCode)

recalculateOrder

protected void recalculateOrder(AbstractOrderModel order)

Recalculates the given order and updates the promotions. (calls CalculationService.calculate(AbstractOrderModel) and PromotionsService.updatePromotions(Collection, AbstractOrderModel)

Throws:

CouponServiceException - if any errors happen during recalculation

getCouponForCode

public java.util.Optional<AbstractCouponModel> getCouponForCode(java.lang.String couponCode)

Description copied from interface: CouponService

Returns Coupon Model object for a given coupon code

Specified by:

getCouponForCode in interface CouponService

Parameters:

couponCode - Coupon code to get coupon details for

Returns:

AbstractCouponModel

getValidatedCouponForCode

public java.util.Optional<AbstractCouponModel> getValidatedCouponForCode(java.lang.String couponCode)

Description copied from interface: CouponService

Returns Coupon Model object for a given coupon code with validation

Specified by:

getValidatedCouponForCode in interface CouponService

Parameters:

couponCode - Coupon code to get coupon details for

Returns:

AbstractCouponModel

releaseCouponCode

public void releaseCouponCode(java.lang.String couponCode,
                              AbstractOrderModel order)

Description copied from interface: CouponService

Release the coupon code from given cart.

Specified by:

releaseCouponCode in interface CouponService

Parameters:

couponCode - Coupon code to release

order - AbstractOrderModel to release the coupon from

removeCouponAndTriggerCalculation

protected void removeCouponAndTriggerCalculation(java.lang.String couponCode,
                                                 AbstractOrderModel order)

getPromotionGroups

protected java.util.Collection<PromotionGroupModel> getPromotionGroups()

getCouponManagementService

protected CouponManagementService getCouponManagementService()

setCouponManagementService

public void setCouponManagementService(CouponManagementService couponManagementService)

getCalculationService

protected CalculationService getCalculationService()

setCalculationService

public void setCalculationService(CalculationService calculationService)

getPromotionsService

protected PromotionsService getPromotionsService()

setPromotionsService

public void setPromotionsService(PromotionsService promotionsService)

getBaseSiteService

protected BaseSiteService getBaseSiteService()

setBaseSiteService

public void setBaseSiteService(BaseSiteService baseSiteService)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getCouponCodeGenerationService

protected CouponCodeGenerationService getCouponCodeGenerationService()

setCouponCodeGenerationService

public void setCouponCodeGenerationService(CouponCodeGenerationService couponCodeGenerationService)