Package com.broadleafcommerce.subscription.job.service

Interface SubscriptionBillingEventGeneratorService

All Known Implementing Classes:

DefaultSubscriptionBillingEventGeneratorService

public interface SubscriptionBillingEventGeneratorService

Method Summary

Modifier and Type	Method	Description
org.apache.commons.lang3.tuple.Pair<SubscriptionWithItemsAndAdjustments,List<BillingEvent>>	generateBillingEventsForNextSubscriptionPeriod(SubscriptionWithItemsAndAdjustments subscription, SubscriptionNextPeriodBillingEventGenerationRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Create billingEventDTOs to process charges if needed
default org.apache.commons.lang3.tuple.Pair<SubscriptionWithItemsAndAdjustments,List<BillingEvent>>	generateBillingEventsForNextSubscriptionPeriod(SubscriptionWithItemsAndAdjustments subscription, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Create billingEventDTOs to process charges if needed
default void	processSubscriptionsAndSaveRecords(String subscriptionJobId, SubscriptionWithItemsAndAdjustments subscriptions, Date billDate)	Deprecated. Use processSubscriptionsAndSaveRecords(String, SubscriptionWithItemsAndAdjustments, Date, ContextInfo) instead
void	processSubscriptionsAndSaveRecords(String subscriptionJobId, SubscriptionWithItemsAndAdjustments subscription, Date billDate, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Adopt the next status for subscription and create billingEventDTOs to process charges if needed

Method Details

processSubscriptionsAndSaveRecords

@Deprecated(since="1.0.0")
default void processSubscriptionsAndSaveRecords(String subscriptionJobId,
 SubscriptionWithItemsAndAdjustments subscriptions,
 Date billDate)

Deprecated.

Use processSubscriptionsAndSaveRecords(String, SubscriptionWithItemsAndAdjustments, Date, ContextInfo) instead

processSubscriptionsAndSaveRecords

void processSubscriptionsAndSaveRecords(String subscriptionJobId,
 SubscriptionWithItemsAndAdjustments subscription,
 Date billDate,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Adopt the next status for subscription and create billingEventDTOs to process charges if needed

Parameters:

subscriptionJobId - subscription job id

subscription - subscription with items and adjustments to process

billDate - bill date of this run

contextInfo - context information around multi-tenant state

generateBillingEventsForNextSubscriptionPeriod

default org.apache.commons.lang3.tuple.Pair<SubscriptionWithItemsAndAdjustments,List<BillingEvent>> generateBillingEventsForNextSubscriptionPeriod(SubscriptionWithItemsAndAdjustments subscription,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Create billingEventDTOs to process charges if needed

Parameters:

subscription - subscription with items and adjustments to process

contextInfo - context information around multi-tenant state

Returns:

The updated SubscriptionWithItemsAndAdjustments

generateBillingEventsForNextSubscriptionPeriod

org.apache.commons.lang3.tuple.Pair<SubscriptionWithItemsAndAdjustments,List<BillingEvent>> generateBillingEventsForNextSubscriptionPeriod(SubscriptionWithItemsAndAdjustments subscription,
 @Nullable
 SubscriptionNextPeriodBillingEventGenerationRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Create billingEventDTOs to process charges if needed

Note that the subscription being processed here does not get advanced into the next period. That is expected to be handled after successful payment processing of the generated billing events, see BillingProcessingResultHandler.

Parameters:

subscription - subscription with items and adjustments to process

request - Request object describing the context around the request to generate a BillingEvent

contextInfo - context information around multi-tenant state

Returns:

The updated SubscriptionWithItemsAndAdjustments