de.hybris.platform.customercouponservices

Interface CustomerCouponService

All Superinterfaces:

CouponService

All Known Implementing Classes:

DefaultCustomerCouponService

public interface CustomerCouponService
extends CouponService

Customer Coupon Service DefaultCustomerCouponService

Method Summary

Modifier and Type	Method and Description
void	assignCouponToCustomer(java.lang.String couponCode, CustomerModel customer) Adds custom to the coupon group.
int	countProductOrCategoryForPromotionSourceRule(java.lang.String code) Finds products is show all products, when coupon not asign with products and category condition will show all products.
java.util.List<CustomerCouponModel>	getAssignableCustomerCoupons(CustomerModel customer, java.lang.String text) Gets all assignable customer coupons can assign to given customer for search text
java.util.List<CustomerCouponModel>	getAssignedCustomerCouponsForCustomer(CustomerModel customer, java.lang.String text) Gets assigned coupons for given customer and search text
java.util.List<java.lang.String>	getCouponCodeForPromotionSourceRule(java.lang.String code) Gets customer coupon code for promotion source rule
java.util.List<CouponNotificationModel>	getCouponNotificationsForCustomer(CustomerModel customer) Gets coupon notifications for customer
boolean	getCouponNotificationStatus(java.lang.String couponCode) Gets coupon notification status by coupon code
java.util.Optional<CustomerCouponModel>	getCustomerCouponForCode(java.lang.String couponCode) Gets customer Coupon for code
SearchPageData<CustomerCouponModel>	getCustomerCouponsForCustomer(CustomerModel customer, PageableData pageableData) Gets all coupons of specific customer
java.util.List<CustomerCouponModel>	getEffectiveCustomerCouponsForCustomer(CustomerModel customer) Gets all coupons of specific customer
java.util.List<PromotionSourceRuleModel>	getExclPromotionSourceRulesForCategory(java.lang.String categoryCode) Gets excluded promotion source rules code list for category
java.util.List<PromotionSourceRuleModel>	getExclPromotionSourceRulesForProduct(java.lang.String productCode) Gets excluded promotion source rules code list for product
SearchPageData<CustomerCouponModel>	getPaginatedCouponsForCustomer(CustomerModel customer, SearchPageData searchPageData) Gets paginated coupons for customer
java.util.List<PromotionSourceRuleModel>	getPromotionSourceRuleForCouponCode(java.lang.String couponCode) Gets promotion source rule for given coupon code
java.util.List<PromotionSourceRuleModel>	getPromotionSourceRulesForCategory(java.lang.String categoryCode) Gets promotion source rules code list for category
java.util.List<PromotionSourceRuleModel>	getPromotionSourceRulesForProduct(java.lang.String productCode) Gets promotion source rules code list for product
java.util.Optional<CustomerCouponModel>	getValidCustomerCouponByCode(java.lang.String couponCode) Gets the customer coupon with enddate >= now for coupon code
void	removeCouponForCustomer(java.lang.String couponCode, CustomerModel customer) Removes a record from CustomerCoupon
void	removeCouponNotificationByCode(java.lang.String couponCode) Removes customer interest coupon message.
void	saveCouponNotification(java.lang.String couponCode) Saves customer interest coupon message.

Methods inherited from interface de.hybris.platform.couponservices.services.CouponService

getCouponForCode, getValidatedCouponForCode, redeemCoupon, redeemCoupon, releaseCouponCode, validateCouponCode, verifyCouponCode

Method Detail

getCustomerCouponsForCustomer

SearchPageData<CustomerCouponModel> getCustomerCouponsForCustomer(CustomerModel customer,
                                                                  PageableData pageableData)

Gets all coupons of specific customer

Parameters:

customer - the specific customer

pageableData - the pageable data

Returns:

paged list of SingleCodeCouponModel

getPromotionSourceRuleForCouponCode

java.util.List<PromotionSourceRuleModel> getPromotionSourceRuleForCouponCode(java.lang.String couponCode)

Gets promotion source rule for given coupon code

Parameters:

couponCode - the given coupon code

Returns:

the Optional of PromotionSourceRuleModel

assignCouponToCustomer

void assignCouponToCustomer(java.lang.String couponCode,
                            CustomerModel customer)

Adds custom to the coupon group.

Parameters:

couponCode - coupon code

customer - customer model

getPromotionSourceRulesForProduct

java.util.List<PromotionSourceRuleModel> getPromotionSourceRulesForProduct(java.lang.String productCode)

Gets promotion source rules code list for product

Parameters:

productCode - product code

Returns:

promotion source rules code list

getExclPromotionSourceRulesForProduct

java.util.List<PromotionSourceRuleModel> getExclPromotionSourceRulesForProduct(java.lang.String productCode)

Gets excluded promotion source rules code list for product

Parameters:

productCode - product code

Returns:

promotion source rules code list

getPromotionSourceRulesForCategory

java.util.List<PromotionSourceRuleModel> getPromotionSourceRulesForCategory(java.lang.String categoryCode)

Gets promotion source rules code list for category

Parameters:

categoryCode - category code

Returns:

promotion source rules code list

getExclPromotionSourceRulesForCategory

java.util.List<PromotionSourceRuleModel> getExclPromotionSourceRulesForCategory(java.lang.String categoryCode)

Gets excluded promotion source rules code list for category

Parameters:

categoryCode - category code

Returns:

promotion source rules code list

getCouponCodeForPromotionSourceRule

java.util.List<java.lang.String> getCouponCodeForPromotionSourceRule(java.lang.String code)

Gets customer coupon code for promotion source rule

Parameters:

code - coupon code

Returns:

coupon code list

countProductOrCategoryForPromotionSourceRule

int countProductOrCategoryForPromotionSourceRule(java.lang.String code)

Finds products is show all products, when coupon not asign with products and category condition will show all products.

Parameters:

code - promotion code

Returns:

product and category number mapping with promotion souce rule.

getValidCustomerCouponByCode

java.util.Optional<CustomerCouponModel> getValidCustomerCouponByCode(java.lang.String couponCode)

Gets the customer coupon with enddate >= now for coupon code

Parameters:

couponCode - customer coupon code

Returns:

Optional of CustomerCouponModel

saveCouponNotification

void saveCouponNotification(java.lang.String couponCode)

Saves customer interest coupon message.

Parameters:

couponCode - coupon code

removeCouponNotificationByCode

void removeCouponNotificationByCode(java.lang.String couponCode)

Removes customer interest coupon message.

Parameters:

couponCode - coupon code

getCouponNotificationStatus

boolean getCouponNotificationStatus(java.lang.String couponCode)

Gets coupon notification status by coupon code

Parameters:

couponCode - coupon code

Returns:

The customer watch the coupon will return true.

removeCouponForCustomer

void removeCouponForCustomer(java.lang.String couponCode,
                             CustomerModel customer)

Removes a record from CustomerCoupon

Parameters:

couponCode - the coupon code

customer - the specific customer

getEffectiveCustomerCouponsForCustomer

java.util.List<CustomerCouponModel> getEffectiveCustomerCouponsForCustomer(CustomerModel customer)

Gets all coupons of specific customer

Parameters:

customer - the specific customer

Returns:

list of CustomerCouponModel

getAssignableCustomerCoupons

java.util.List<CustomerCouponModel> getAssignableCustomerCoupons(CustomerModel customer,
                                                                 java.lang.String text)

Gets all assignable customer coupons can assign to given customer for search text

Parameters:

customer - the given customer

text - search text

Returns:

List list of CustomerCouponModel

getAssignedCustomerCouponsForCustomer

java.util.List<CustomerCouponModel> getAssignedCustomerCouponsForCustomer(CustomerModel customer,
                                                                          java.lang.String text)

Gets assigned coupons for given customer and search text

Parameters:

customer - the given customer

text - search text

getCustomerCouponForCode

java.util.Optional<CustomerCouponModel> getCustomerCouponForCode(java.lang.String couponCode)

Gets customer Coupon for code

Parameters:

couponCode - coupon code

Returns:

CustomerCouponModel only return customer coupon,single and multi coupon will return null.

getPaginatedCouponsForCustomer

SearchPageData<CustomerCouponModel> getPaginatedCouponsForCustomer(CustomerModel customer,
                                                                   SearchPageData searchPageData)

Gets paginated coupons for customer

Parameters:

customer - the specific customer

searchPageData - the search page data

Returns:

search paged result

getCouponNotificationsForCustomer

java.util.List<CouponNotificationModel> getCouponNotificationsForCustomer(CustomerModel customer)

Gets coupon notifications for customer

Parameters:

customer - the specific customer

Returns:

list of coupon notifications for customer