Package com.broadleafcommerce.subscription.repository

Interface CustomizedSubscriptionRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable>

All Known Subinterfaces:

JpaSubscriptionRepository<D>, SubscriptionRepository<D>

All Known Implementing Classes:

JpaCustomizedSubscriptionRepository

public interface CustomizedSubscriptionRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable>

Method Summary

Modifier and Type	Method	Description
default Long	countAllBySubscriptionStatus(String subscriptionStatus)	Deprecated. Use countAllBySubscriptionStatus(String, ContextInfo) instead
Long	countAllBySubscriptionStatus(String subscriptionStatus, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Count subscriptions matching the subscriptionStatus.
org.springframework.data.domain.Page<D>	findAllByPriceData(String priceDataId, Set<String> statuses, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Find all subscriptions by priceDataId.
default org.springframework.data.domain.Page<String>	findAllBySubscriptionStatus(String subscriptionStatus, org.springframework.data.domain.Pageable pageable)	Deprecated. Use findContextIdsBySubscriptionStatus(String, Pageable, ContextInfo) instead
default List<D>	findAllBySubscriptionStatusAndBillingOperationStatus(List<String> subscriptionStatus, Date nextBillDate, org.springframework.data.domain.Pageable pageable)	Deprecated. Use findAllBySubscriptionStatusInAndNextBillDateBeforeOrNullAndNextStatusChangeDateBefore(List, Date, Pageable, ContextInfo) instead
org.springframework.data.domain.Page<D>	findAllBySubscriptionStatusInAndNextBillDateBeforeOrNextStatusChangeDateBeforeOrEndOfTermDateBefore(List<String> subscriptionStatuses, Date dateToFilter, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Find subscriptions within the following criteria: subscriptionStatus in the given list billing frequency is DefaultSubscriptionBillingFrequencyEnum.NON_RENEWING OR the Subscription.getNextBillDate() is before or equal the given date OR the Subscription.getNextStatusChangeDate() is before or equal the given date OR the Subscription.getEndOfTermDate() is before or equal the given date lastBillingOperationStatus is null OR is either PaymentStatusEnum.SUCCESS or PaymentStatusEnum.ABORTED Note that the last condition prevents subscriptions that are being processed by another subscription job to be picked up again.
org.springframework.data.domain.Page<D>	findAllBySubscriptionStatusInAndNextBillDateBeforeOrNullAndNextStatusChangeDateBefore(List<String> subscriptionStatuses, Date dateToFilter, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Find subscriptions within the following criteria: subscriptionStatus in the given list billing frequency is DefaultSubscriptionBillingFrequencyEnum.NON_RENEWING OR the nextBillDate before or equal the given date OR nextBillDate is null and the nextStatusChangeDate is before or equal the given date lastBillingOperationStatus is null OR is either PaymentStatusEnum.SUCCESS or PaymentStatusEnum.ABORTED Note that the last condition prevents subscriptions that are being processed by another subscription job to be picked up again.
default List<D>	findAllByUserRefAndSubscriptionItemsItemRefIn(String userRef, Collection<String> itemRefs)	Deprecated. Use findAllByUserRefTypeAndUserRefAndSubscriptionItemsItemRefIn(String, String, Collection, ContextInfo) instead
List<D>	findAllByUserRefTypeAndUserRefAndActive(String userRefType, String userRef, boolean includeInactive, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Find all subscriptions by userId.
List<D>	findAllByUserRefTypeAndUserRefAndSubscriptionItemsItemRefIn(String userRefType, String userRef, Collection<String> itemRefs, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
Optional<D>	findByMatchingSubscriptionSource(Subscription subscription, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Find a Subscription with the source matching the Subscription given.
org.springframework.data.domain.Page<String>	findContextIdsBySubscriptionStatus(String subscriptionStatus, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieve contextIds of subscriptions matching the subscriptionStatus
default List<D>	listSubscriptions(@NotBlank String userId, boolean includeInactive)	Deprecated. Use findAllByUserRefTypeAndUserRefAndActive(String, String, boolean, ContextInfo) instead

Method Details

listSubscriptions

@Deprecated(since="1.0.0")
@Policy(operationTypes=READ)
default List<D> listSubscriptions(@NotBlank
 @NotBlank String userId,
 boolean includeInactive)

Deprecated.

Use findAllByUserRefTypeAndUserRefAndActive(String, String, boolean, ContextInfo) instead

Find all subscriptions by userId. Optionally include inactive subscriptions.

findAllByUserRefTypeAndUserRefAndActive

@Policy(operationTypes=READ)
List<D> findAllByUserRefTypeAndUserRefAndActive(String userRefType,
 String userRef,
 boolean includeInactive,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Find all subscriptions by userId. Optionally include inactive subscriptions.

findAllBySubscriptionStatus

@Deprecated(since="1.0.0")
@Policy(operationTypes=READ)
default org.springframework.data.domain.Page<String> findAllBySubscriptionStatus(String subscriptionStatus,
 org.springframework.data.domain.Pageable pageable)

Deprecated.

Use findContextIdsBySubscriptionStatus(String, Pageable, ContextInfo) instead

findContextIdsBySubscriptionStatus

@Policy(operationTypes=READ)
org.springframework.data.domain.Page<String> findContextIdsBySubscriptionStatus(String subscriptionStatus,
 org.springframework.data.domain.Pageable pageable,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Retrieve contextIds of subscriptions matching the subscriptionStatus

findAllByPriceData

@Policy(operationTypes=READ)
org.springframework.data.domain.Page<D> findAllByPriceData(String priceDataId,
 Set<String> statuses,
 org.springframework.data.domain.Pageable page,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Find all subscriptions by priceDataId.

Parameters:

priceDataId - The id of the priceData belonging to one or more of the contained SubscriptionItem instances.

statuses - Set of statuses to filter by.

page - The page information

contextInfo - Additional sandbox and multitenant info

countAllBySubscriptionStatus

@Deprecated(since="1.0.0")
@Policy(operationTypes=READ)
default Long countAllBySubscriptionStatus(String subscriptionStatus)

Deprecated.

Use countAllBySubscriptionStatus(String, ContextInfo) instead

countAllBySubscriptionStatus

@Policy(operationTypes=READ)
Long countAllBySubscriptionStatus(String subscriptionStatus,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Count subscriptions matching the subscriptionStatus.

findAllBySubscriptionStatusAndBillingOperationStatus

@Deprecated(since="1.0.0")
@Policy(operationTypes=READ)
default List<D> findAllBySubscriptionStatusAndBillingOperationStatus(List<String> subscriptionStatus,
 Date nextBillDate,
 org.springframework.data.domain.Pageable pageable)

Deprecated.

Use findAllBySubscriptionStatusInAndNextBillDateBeforeOrNullAndNextStatusChangeDateBefore(List, Date, Pageable, ContextInfo) instead

findAllBySubscriptionStatusInAndNextBillDateBeforeOrNullAndNextStatusChangeDateBefore

@Policy(operationTypes=READ)
org.springframework.data.domain.Page<D> findAllBySubscriptionStatusInAndNextBillDateBeforeOrNullAndNextStatusChangeDateBefore(List<String> subscriptionStatuses,
 Date dateToFilter,
 org.springframework.data.domain.Pageable pageable,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Find subscriptions within the following criteria:

• subscriptionStatus in the given list
• billing frequency is DefaultSubscriptionBillingFrequencyEnum.NON_RENEWING OR the nextBillDate before or equal the given date OR nextBillDate is null and the nextStatusChangeDate is before or equal the given date
• lastBillingOperationStatus is null OR is either PaymentStatusEnum.SUCCESS or PaymentStatusEnum.ABORTED Note that the last condition prevents subscriptions that are being processed by another subscription job to be picked up again.

findAllBySubscriptionStatusInAndNextBillDateBeforeOrNextStatusChangeDateBeforeOrEndOfTermDateBefore

@Policy(operationTypes=READ)
org.springframework.data.domain.Page<D> findAllBySubscriptionStatusInAndNextBillDateBeforeOrNextStatusChangeDateBeforeOrEndOfTermDateBefore(List<String> subscriptionStatuses,
 Date dateToFilter,
 org.springframework.data.domain.Pageable pageable,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Find subscriptions within the following criteria:

• subscriptionStatus in the given list
• billing frequency is DefaultSubscriptionBillingFrequencyEnum.NON_RENEWING OR the Subscription.getNextBillDate() is before or equal the given date OR the Subscription.getNextStatusChangeDate() is before or equal the given date OR the Subscription.getEndOfTermDate() is before or equal the given date
• lastBillingOperationStatus is null OR is either PaymentStatusEnum.SUCCESS or PaymentStatusEnum.ABORTED Note that the last condition prevents subscriptions that are being processed by another subscription job to be picked up again.

findByMatchingSubscriptionSource

@Policy(operationTypes=READ)
Optional<D> findByMatchingSubscriptionSource(Subscription subscription,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Find a Subscription with the source matching the Subscription given. By default, this is based on Subscription.getSubscriptionSource(), Subscription.getSubscriptionSourceRef(), Subscription.getSecondarySourceType(), and Subscription.getSecondarySourceRef().

Parameters:

subscription - A Subscription for which to find a matching source.

findAllByUserRefAndSubscriptionItemsItemRefIn

@Deprecated(since="1.0.0")
@Policy(operationTypes=READ)
default List<D> findAllByUserRefAndSubscriptionItemsItemRefIn(String userRef,
 Collection<String> itemRefs)

Deprecated.

Use findAllByUserRefTypeAndUserRefAndSubscriptionItemsItemRefIn(String, String, Collection, ContextInfo) instead

findAllByUserRefTypeAndUserRefAndSubscriptionItemsItemRefIn

@Policy(operationTypes=READ)
List<D> findAllByUserRefTypeAndUserRefAndSubscriptionItemsItemRefIn(String userRefType,
 String userRef,
 Collection<String> itemRefs,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)