com.broadleafcommerce.subscription.service

Interface SubscriptionService

All Known Implementing Classes:

SubscriptionServiceImpl

public interface SubscriptionService

Provides services needed for processing subscriptions.

Author:

charchar

Method Summary

Modifier and Type	Method and Description
Calendar	cartFutureStartDate(org.broadleafcommerce.core.order.domain.Order cart)
Subscription	create() creates a new subscription
void	delete(Subscription subscription) physically deletes a subscription from the database
ScheduledPayment	findScheduledPaymentByPeriodAndSubscription(Subscription subscription, Integer period) Reads the scheduled payment with the matching period and Subscription
SubscriptionSku	findSkuByUpgradeFamilyTypeAndLevel(String upgradeFamilyType, Integer upgradeLevel) Finds the subscription sku for a specific upgradeFamilyType and upgradeLevel
Subscription	findSubscriptionById(Long subscriptionId) finds a specific subscription
Subscription	findSubscriptionByOrderItemIdAndCustomerId(Long orderItemId, Long customerId, Boolean activeOnly) Retrieves the subscription with the matching Order and a Customer
Subscription	findSubscriptionBySkuIdAndCustomerId(Long productId, Long customerId) Find an active subscription for the given product and customer
Subscription	findSubscriptionByUpgradeFamilyTypeAndCustomer(String upgradeFamily, org.broadleafcommerce.profile.core.domain.Customer customer) Returns the active subscription from an upgrade family for the given customer.
List<Subscription>	findSubscriptionsByCustomerId(Long customerId, boolean activeOnly) retrieves all subscriptions by a given customer.
List<Subscription>	findSubscriptionsByDayOfMonth(org.broadleafcommerce.common.time.DayOfMonthType dayOfMonth, boolean activeOnly) retrieves all subscriptions due by a specific day of the month.
Calendar	futureStartDateForOrderItem(org.broadleafcommerce.core.order.domain.DiscreteOrderItem discreteOrderItem)
Integer	getDefaultStartPeriod() Returns the default start period relative to the order date.
Calendar	getNextBillingDateForCustomer(org.broadleafcommerce.profile.core.domain.Customer c, int relativePeriod, BillingFrequencyType freqType, Calendar futureStartDate)
Date	getNextBillingDateForSubscription(Subscription subscription) Calculates the date for the next scheduled billing job to run for the referenced subscription, given the primary order's submit date and the billing frequency on the order items
Date	getNextBillingDateForSubscription(Subscription subscription, Integer period) Used to determine the billing date of a subscription object for the given period.
ScheduledPayment	getNextScheduledPrice(Subscription subscription, org.broadleafcommerce.core.order.domain.OrderItem orderItem) accurately calculates, based solely on the current subscription information, the next estimated retail price for a specific orderItem
Calendar	getOriginalBillingDateForCustomer(org.broadleafcommerce.profile.core.domain.Customer c, BillingFrequencyType freqType)
org.broadleafcommerce.common.money.Money	getProratedPriceForUpgrade(org.broadleafcommerce.common.money.Money newPrice, Subscription subscription) Returns the prorated price calculated by determining days of the month left in the subscription as a percent of the new price passed in.
List<ScheduledPayment>	getScheduledPayments(Subscription subscription, org.broadleafcommerce.core.order.domain.OrderItem orderItem) Calculates the next scheduled payment for a specific order item within the primary order of the subscriptions
List<ScheduledPayment>	getScheduledPaymentsForOrder(String billingFrequencyType, SubscriptionOrder subOrder, int startPeriod, int endPeriod, Calendar futureStartDate)
Calendar	getStartDateForOrderItem(org.broadleafcommerce.core.order.domain.OrderItem orderItem)
Boolean	isItemUpgrade(org.broadleafcommerce.profile.core.domain.Customer customer, org.broadleafcommerce.core.order.domain.DiscreteOrderItem subscriptionItem) Returns whether the passed in subscription item would be considered and upgrade to an existing subscription for the given customer
Calendar	overrideGetCalendarForNextBillingDate(BillingFrequencyType freqType, Calendar returnDate, Integer relativePeriod) This method is intended to be overridden for custom billing date calculation whenever a custom BillingFrequencyType is passed in.
Integer	overrideGetNextPeriod(BillingFrequencyType frequencyType, org.joda.time.LocalDate startSubscriptionDate, org.joda.time.LocalDate today) This method is intended to be overridden for custom period calculation whenever a custom BillingFrequencyType is passed in.
Calendar	parseDateToCalendar(Calendar calendar, String value)
Subscription	save(Subscription subscription) saves a subscription to the database

Method Detail

getScheduledPayments

List<ScheduledPayment> getScheduledPayments(Subscription subscription,
                                            org.broadleafcommerce.core.order.domain.OrderItem orderItem)

Calculates the next scheduled payment for a specific order item within the primary order of the subscriptions

Parameters:

subscription -

orderItem -

Returns:

overrideGetNextPeriod

Integer overrideGetNextPeriod(BillingFrequencyType frequencyType,
                              org.joda.time.LocalDate startSubscriptionDate,
                              org.joda.time.LocalDate today)

This method is intended to be overridden for custom period calculation whenever a custom BillingFrequencyType is passed in.

Parameters:

frequencyType -

startSubscriptionDate -

today -

Returns:

getNextBillingDateForSubscription

Date getNextBillingDateForSubscription(Subscription subscription,
                                       Integer period)

Used to determine the billing date of a subscription object for the given period. If period is null, assume that this is a new Subscription. For cases where the month "rolls", the system will return end of month. So, for a customer whose original billing date was 1/30, their February date will return 1/28 (or 1/29 in leap years).

Parameters:

subscription -

period -

Returns:

overrideGetCalendarForNextBillingDate

Calendar overrideGetCalendarForNextBillingDate(BillingFrequencyType freqType,
                                               Calendar returnDate,
                                               Integer relativePeriod)

This method is intended to be overridden for custom billing date calculation whenever a custom BillingFrequencyType is passed in.

Parameters:

freqType -

returnDate -

relativePeriod -

Returns:

getScheduledPaymentsForOrder

List<ScheduledPayment> getScheduledPaymentsForOrder(String billingFrequencyType,
                                                    SubscriptionOrder subOrder,
                                                    int startPeriod,
                                                    int endPeriod,
                                                    Calendar futureStartDate)

getOriginalBillingDateForCustomer

Calendar getOriginalBillingDateForCustomer(org.broadleafcommerce.profile.core.domain.Customer c,
                                           BillingFrequencyType freqType)

getNextBillingDateForCustomer

Calendar getNextBillingDateForCustomer(org.broadleafcommerce.profile.core.domain.Customer c,
                                       int relativePeriod,
                                       BillingFrequencyType freqType,
                                       Calendar futureStartDate)

getDefaultStartPeriod

Integer getDefaultStartPeriod()

Returns the default start period relative to the order date. Typically 1. Used to display future payments.

Returns:

findSubscriptionById

Subscription findSubscriptionById(Long subscriptionId)

finds a specific subscription

Parameters:

subscriptionId -

Returns:

findSubscriptionsByCustomerId

List<Subscription> findSubscriptionsByCustomerId(Long customerId,
                                                 boolean activeOnly)

retrieves all subscriptions by a given customer. Optionally, only the active ones.

Parameters:

customerId -

activeOnly -

Returns:

findSubscriptionsByDayOfMonth

List<Subscription> findSubscriptionsByDayOfMonth(org.broadleafcommerce.common.time.DayOfMonthType dayOfMonth,
                                                 boolean activeOnly)

retrieves all subscriptions due by a specific day of the month. Optionally, only the active ones

Parameters:

dayOfMonth -

activeOnly -

Returns:

findSubscriptionByOrderItemIdAndCustomerId

Subscription findSubscriptionByOrderItemIdAndCustomerId(Long orderItemId,
                                                        Long customerId,
                                                        Boolean activeOnly)

Retrieves the subscription with the matching Order and a Customer

Parameters:

orderId -

customerId -

Returns:

findSubscriptionBySkuIdAndCustomerId

Subscription findSubscriptionBySkuIdAndCustomerId(Long productId,
                                                  Long customerId)

Find an active subscription for the given product and customer

Parameters:

skuId -

customerId -

Returns:

save

Subscription save(Subscription subscription)

saves a subscription to the database

Parameters:

subscription -

Returns:

create

Subscription create()

creates a new subscription

Returns:

delete

void delete(Subscription subscription)

physically deletes a subscription from the database

Parameters:

subscription -

getNextScheduledPrice

ScheduledPayment getNextScheduledPrice(Subscription subscription,
                                       org.broadleafcommerce.core.order.domain.OrderItem orderItem)

accurately calculates, based solely on the current subscription information, the next estimated retail price for a specific orderItem

Parameters:

subscription -

Returns:

getNextBillingDateForSubscription

Date getNextBillingDateForSubscription(Subscription subscription)

Calculates the date for the next scheduled billing job to run for the referenced subscription, given the primary order's submit date and the billing frequency on the order items

Parameters:

subscription -

Returns:

findScheduledPaymentByPeriodAndSubscription

ScheduledPayment findScheduledPaymentByPeriodAndSubscription(Subscription subscription,
                                                             Integer period)

Reads the scheduled payment with the matching period and Subscription

Parameters:

subscription -

period -

Returns:

findSkuByUpgradeFamilyTypeAndLevel

SubscriptionSku findSkuByUpgradeFamilyTypeAndLevel(String upgradeFamilyType,
                                                   Integer upgradeLevel)

Finds the subscription sku for a specific upgradeFamilyType and upgradeLevel

Parameters:

upgradeFamilyType -

upgradeLevel -

Returns:

findSubscriptionByUpgradeFamilyTypeAndCustomer

Subscription findSubscriptionByUpgradeFamilyTypeAndCustomer(String upgradeFamily,
                                                            org.broadleafcommerce.profile.core.domain.Customer customer)

Returns the active subscription from an upgrade family for the given customer.

Parameters:

upgradeFamily -

customer -

Returns:

isItemUpgrade

Boolean isItemUpgrade(org.broadleafcommerce.profile.core.domain.Customer customer,
                      org.broadleafcommerce.core.order.domain.DiscreteOrderItem subscriptionItem)

Returns whether the passed in subscription item would be considered and upgrade to an existing subscription for the given customer

Parameters:

customer -

subscriptionItem -

Returns:

getProratedPriceForUpgrade

org.broadleafcommerce.common.money.Money getProratedPriceForUpgrade(org.broadleafcommerce.common.money.Money newPrice,
                                                                    Subscription subscription)

Returns the prorated price calculated by determining days of the month left in the subscription as a percent of the new price passed in.

Parameters:

newPrice -

subscription -

Returns:

getStartDateForOrderItem

Calendar getStartDateForOrderItem(org.broadleafcommerce.core.order.domain.OrderItem orderItem)
                           throws Exception

Throws:

Exception

parseDateToCalendar

Calendar parseDateToCalendar(Calendar calendar,
                             String value)
                      throws Exception

Throws:

Exception

cartFutureStartDate

Calendar cartFutureStartDate(org.broadleafcommerce.core.order.domain.Order cart)

futureStartDateForOrderItem

Calendar futureStartDateForOrderItem(org.broadleafcommerce.core.order.domain.DiscreteOrderItem discreteOrderItem)