Package com.broadleafcommerce.promotion.offer.service

Interface OfferAndOfferCodeUsabilityService

All Known Implementing Classes:
DefaultOfferAndOfferCodeUsabilityService
public interface OfferAndOfferCodeUsabilityService
Author:
Chad Harchar (charchar)

  • Method Summary

    Modifier and Type
    Method
    Description
    OffersAndOfferCodesUsabilityInfo
    getOfferAndOfferCodeUsabilityInfo(List<String> codes, com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext customerContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Checks the provided codes against the offer codes and offers to determine whether the code is usable.
    OffersAndOfferCodesUsabilityInfo
    getOfferAndOfferCodeUsabilityInfo(List<String> codes, List<? extends Offer> offers, com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext customerContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Checks the provided codes against the offer codes and provided offers to determine whether the code is usable.

  • Method Details

    • getOfferAndOfferCodeUsabilityInfo

      @NonNull OffersAndOfferCodesUsabilityInfo getOfferAndOfferCodeUsabilityInfo(@NonNull List<String> codes, @Nullable com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext customerContext, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Checks the provided codes against the offer codes and offers to determine whether the code is usable.
      Parameters:
      codes - the codes for which to check usability
      customerContext - context information for the customer
      contextInfo - context information around sandbox and multitenant state
      Returns:
      a OffersAndOfferCodesUsabilityInfo which contains information to determine whether or not the codes can be used

    • getOfferAndOfferCodeUsabilityInfo

      @NonNull OffersAndOfferCodesUsabilityInfo getOfferAndOfferCodeUsabilityInfo(@NonNull List<String> codes, @NonNull List<? extends Offer> offers, @Nullable com.broadleafcommerce.promotion.offer.client.web.context.CustomerContext customerContext, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Checks the provided codes against the offer codes and provided offers to determine whether the code is usable.
      Parameters:
      codes - the code for which to check usability
      offers - the list of offers to check usability
      customerContext - context information for the customer
      contextInfo - context information around sandbox and multitenant state
      Returns:
      a OffersAndOfferCodesUsabilityInfo which contains information to determine whether or not the offers and codes can be used