de.hybris.platform.couponservices.services

Interface CouponService

All Known Implementing Classes:

DefaultCouponService

public interface CouponService

Coupon service interface. To be used by facade to query/manage the coupon lifecycle

Method Summary

Modifier and Type	Method and Description
Optional<CouponCodeDetails>	getCouponDetails(String couponCode) Deprecated. since version 6.2 use getValidatedCouponForCode method instead Get coupon code details by couponCode
Optional<AbstractCouponModel>	getCouponForCode(String couponCode) Returns Coupon Model object for a given coupon code
Optional<AbstractCouponModel>	getValidatedCouponForCode(String couponCode) Returns Coupon Model object for a given coupon code with validation
CouponResponse	redeemCoupon(String couponCode, CartModel cart) Redeem the coupon code associated with the cart.
CouponResponse	redeemCoupon(String couponCode, OrderModel order) Create a coupon redemption instance for the coupon redeemed for the order.
void	releaseCouponCode(String couponCode, AbstractOrderModel order) Release the coupon code from given cart.
CouponResponse	validateCouponCode(String couponCode, UserModel user) Validate if provided couponCode is valid.
CouponResponse	verifyCouponCode(String couponCode, AbstractOrderModel order) Verify if provided couponCode is valid.

Method Detail

releaseCouponCode

void releaseCouponCode(String couponCode,
                       AbstractOrderModel order)

Release the coupon code from given cart.

Parameters:

couponCode - Coupon code to release

order - AbstractOrderModel to release the coupon from

verifyCouponCode

CouponResponse verifyCouponCode(String couponCode,
                                AbstractOrderModel order)

Verify if provided couponCode is valid.

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

CouponResponse validateCouponCode(String couponCode,
                                  UserModel user)

Validate if provided couponCode is valid.

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.

getCouponDetails

@Deprecated
Optional<CouponCodeDetails> getCouponDetails(String couponCode)

Deprecated. since version 6.2 use getValidatedCouponForCode method instead Get coupon code details by couponCode

Parameters:

couponCode - coupon code to retrieve details

Returns:

CouponCodeDetails

getCouponForCode

Optional<AbstractCouponModel> getCouponForCode(String couponCode)

Returns Coupon Model object for a given coupon code

Parameters:

couponCode - Coupon code to get coupon details for

Returns:

AbstractCouponModel

getValidatedCouponForCode

Optional<AbstractCouponModel> getValidatedCouponForCode(String couponCode)

Returns Coupon Model object for a given coupon code with validation

Parameters:

couponCode - Coupon code to get coupon details for

Returns:

AbstractCouponModel

redeemCoupon

CouponResponse redeemCoupon(String couponCode,
                            CartModel cart)

Redeem the coupon code associated with the cart.

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.

redeemCoupon

CouponResponse redeemCoupon(String couponCode,
                            OrderModel order)

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

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.