Interface CouponManagementService
- All Known Implementing Classes:
DefaultCouponManagementService
public interface CouponManagementService
Provides methods for managing coupons, like verifying if coupon code is valid or finding all coupons.
-
Method Summary
Modifier and TypeMethodDescriptiongetCouponForCode(String couponCode) Returns Coupon Model object for a given coupon code without validationgetValidatedCouponForCode(String couponCode) Returns Coupon Model object for a given coupon code with validationbooleanRedeems coupon (called when coupon code is applied in cart).redeem(String couponCode, OrderModel order) Redeems coupon (called when order is placed).voidreleaseCouponCode(String couponCode) Releases coupon provided incouponCode.validateCouponCode(String couponCode, UserModel user) Verify if given coupon code is valid.verifyCouponCode(String couponCode, AbstractOrderModel abstractOrder) Verify if given coupon code is valid.
-
Method Details
-
getCouponForCode
Returns Coupon Model object for a given coupon code without validation- Parameters:
couponCode- Coupon code to get coupon details for- Returns:
AbstractCouponModel
-
getValidatedCouponForCode
Returns Coupon Model object for a given coupon code with validation- Parameters:
couponCode- Coupon code to get coupon details for- Returns:
AbstractCouponModel
-
verifyCouponCode
Verify if given coupon code is valid.- Parameters:
couponCode- Coupon code to checkabstractOrder-AbstractOrderModelfor which the coupon will be redeemed- Returns:
CouponResponsecontaining true if coupon code is valid or false if not, including the message why it is not valid.
-
validateCouponCode
Verify if given coupon code is valid.- Parameters:
couponCode- Coupon code to checkuser-UserModelfor which the coupon will be redeemed- Returns:
CouponResponsecontaining true if coupon code is valid or false if not, including the message why it is not valid.
-
releaseCouponCode
Releases coupon provided incouponCode.- Parameters:
couponCode- Coupon code to release
-
redeem
Redeems coupon (called when coupon code is applied in cart). throws CouponServiceException when verify coupon code fails- Parameters:
couponCode- Coupon code to redeemcart-CartModelto redeem coupon- Returns:
- boolean true if coupon code could be redeemed at cart or false if not.
-
redeem
Redeems coupon (called when order is placed).- Parameters:
couponCode- Coupon code to redeemorder-OrderModelto redeem coupon- Returns:
- CouponResponse
-