de.hybris.platform.couponservices.services.impl

Class DefaultCouponManagementService

java.lang.Object

de.hybris.platform.couponservices.services.impl.DefaultCouponManagementService

All Implemented Interfaces:

CouponManagementService

public class DefaultCouponManagementService
extends Object
implements CouponManagementService

Default implementation of CouponManagementService.

Constructor Summary

Constructors

Constructor and Description
DefaultCouponManagementService()

Method Summary

Modifier and Type	Method and Description
protected Optional<AbstractCouponModel>	checkCouponRedeemability(AbstractCouponModel coupon, UserModel user, String couponCode)
protected Optional<AbstractCouponModel>	checkRedeemability(AbstractCouponModel coupon, AbstractOrderModel order, String couponCode)
protected void	createCouponRedemption(String couponCode, OrderModel order)
protected Optional<AbstractCouponModel>	findCoupon(String couponCode, AbstractOrderModel order)
protected Optional<AbstractCouponModel>	findValidatedCoupon(String couponCode, UserModel user)
Optional<CouponCodeDetails>	getCouponDetails(String couponCode) Deprecated. (since 6.2)
Optional<AbstractCouponModel>	getCouponForCode(String couponCode) Returns Coupon Model object for a given coupon code without validation
protected Optional<AbstractCouponModel>	getCouponForCode(String couponCode, Function<FindCouponStrategy,Optional<AbstractCouponModel>> findCouponFunction)
protected List<FindCouponStrategy>	getFindCouponStrategiesList()
protected ModelService	getModelService()
protected Map<String,CouponRedemptionStrategy>	getRedemptionStrategyMap()
Optional<AbstractCouponModel>	getValidatedCouponForCode(String couponCode) Returns Coupon Model object for a given coupon code with validation
boolean	redeem(String couponCode, CartModel cart) Redeems coupon (called when coupon code is applied in cart).
CouponResponse	redeem(String couponCode, OrderModel order) Redeems coupon (called when order is placed).
void	releaseCouponCode(String couponCode) Releases coupon provided in couponCode.
void	setFindCouponStrategiesList(List<FindCouponStrategy> findCouponStrategiesList)
void	setModelService(ModelService modelService)
void	setRedemptionStrategyMap(Map<String,CouponRedemptionStrategy> redemptionStrategyMap)
CouponResponse	validateCouponCode(String couponCode, UserModel user) Verify if given coupon code is valid.
CouponResponse	verifyCouponCode(String couponCode, AbstractOrderModel abstractOrder) Verify if given coupon code is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCouponManagementService

public DefaultCouponManagementService()

Method Detail

getCouponDetails

@Deprecated
public Optional<CouponCodeDetails> getCouponDetails(String couponCode)

Deprecated. (since 6.2)

Specified by:

getCouponDetails in interface CouponManagementService

Parameters:

couponCode - Coupon code to get coupon details for

Returns:

CouponCodeDetails

getCouponForCode

public Optional<AbstractCouponModel> getCouponForCode(String couponCode)

Description copied from interface: CouponManagementService

Returns Coupon Model object for a given coupon code without validation

Specified by:

getCouponForCode in interface CouponManagementService

Parameters:

couponCode - Coupon code to get coupon details for

Returns:

AbstractCouponModel

getValidatedCouponForCode

public Optional<AbstractCouponModel> getValidatedCouponForCode(String couponCode)

Description copied from interface: CouponManagementService

Returns Coupon Model object for a given coupon code with validation

Specified by:

getValidatedCouponForCode in interface CouponManagementService

Parameters:

couponCode - Coupon code to get coupon details for

Returns:

AbstractCouponModel

getCouponForCode

protected Optional<AbstractCouponModel> getCouponForCode(String couponCode,
                                                         Function<FindCouponStrategy,Optional<AbstractCouponModel>> findCouponFunction)

verifyCouponCode

public CouponResponse verifyCouponCode(String couponCode,
                                       AbstractOrderModel abstractOrder)

Description copied from interface: CouponManagementService

Verify if given coupon code is valid.

Specified by:

verifyCouponCode in interface CouponManagementService

Parameters:

couponCode - Coupon code to check

abstractOrder - AbstractOrderModel for which the coupon will be redeemed

Returns:

CouponResponse containing true if coupon code is valid or false if not, including the message why it is not valid.

validateCouponCode

public CouponResponse validateCouponCode(String couponCode,
                                         UserModel user)

Description copied from interface: CouponManagementService

Verify if given coupon code is valid.

Specified by:

validateCouponCode in interface CouponManagementService

Parameters:

couponCode - Coupon code to check

user - UserModel for which the coupon will be redeemed

Returns:

CouponResponse containing true if coupon code is valid or false if not, including the message why it is not valid.

findCoupon

protected Optional<AbstractCouponModel> findCoupon(String couponCode,
                                                   AbstractOrderModel order)

findValidatedCoupon

protected Optional<AbstractCouponModel> findValidatedCoupon(String couponCode,
                                                            UserModel user)

checkRedeemability

protected Optional<AbstractCouponModel> checkRedeemability(AbstractCouponModel coupon,
                                                           AbstractOrderModel order,
                                                           String couponCode)

checkCouponRedeemability

protected Optional<AbstractCouponModel> checkCouponRedeemability(AbstractCouponModel coupon,
                                                                 UserModel user,
                                                                 String couponCode)

releaseCouponCode

public void releaseCouponCode(String couponCode)

Description copied from interface: CouponManagementService

Releases coupon provided in couponCode.

Specified by:

releaseCouponCode in interface CouponManagementService

Parameters:

couponCode - Coupon code to release

redeem

public boolean redeem(String couponCode,
                      CartModel cart)

Description copied from interface: CouponManagementService

Redeems coupon (called when coupon code is applied in cart). throws CouponServiceException when verify coupon code fails

Specified by:

redeem in interface CouponManagementService

Parameters:

couponCode - Coupon code to redeem

cart - CartModel to redeem coupon

Returns:

boolean true if coupon code could be redeemed at cart or false if not.

redeem

public CouponResponse redeem(String couponCode,
                             OrderModel order)

Description copied from interface: CouponManagementService

Redeems coupon (called when order is placed).

Specified by:

redeem in interface CouponManagementService

Parameters:

couponCode - Coupon code to redeem

order - OrderModel to redeem coupon

Returns:

CouponResponse

createCouponRedemption

protected void createCouponRedemption(String couponCode,
                                      OrderModel order)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

setRedemptionStrategyMap

public void setRedemptionStrategyMap(Map<String,CouponRedemptionStrategy> redemptionStrategyMap)

getRedemptionStrategyMap

protected Map<String,CouponRedemptionStrategy> getRedemptionStrategyMap()

getFindCouponStrategiesList

protected List<FindCouponStrategy> getFindCouponStrategiesList()

setFindCouponStrategiesList

public void setFindCouponStrategiesList(List<FindCouponStrategy> findCouponStrategiesList)