Package com.broadleafcommerce.subscriptionoperation.service

Interface UserSubscriptionSummaryService<U extends UserSubscriptionSummary,SWI extends SubscriptionWithItems>

Type Parameters:
U - extension of UserSubscriptionSummary
SWI - extension of SubscriptionWithItems
All Known Implementing Classes:
DefaultUserSubscriptionSummaryService
public interface UserSubscriptionSummaryService<U extends UserSubscriptionSummary,SWI extends SubscriptionWithItems>
Service for operations on UserSubscriptionSummary
Author:
karanjariwala

  • Method Summary

    Modifier and Type
    Method
    Description
    U
    buildUserSubscriptionSummary(String userRefType, String userRef, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Reads a UserSubscriptionSummary for a user with a particular userRef, and userRefType.

  • Method Details

    • buildUserSubscriptionSummary

      U buildUserSubscriptionSummary(String userRefType, String userRef, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reads a UserSubscriptionSummary for a user with a particular userRef, and userRefType.

      This is primarily used for identifying a user's active and former subscriptions.

      Parameters:
      userRefType - the type of userRef
      userRef - the reference to the user
      contextInfo - context information around multi-tenant state
      Returns:
      UserSubscriptionSummary containing details about the user's active and former subscriptions.