org.killbill.billing.subscription.api.user

Class DefaultSubscriptionBaseApiService

java.lang.Object

org.killbill.billing.subscription.api.user.DefaultSubscriptionBaseApiService

All Implemented Interfaces:

SubscriptionBaseApiService

public class DefaultSubscriptionBaseApiService
extends Object
implements SubscriptionBaseApiService

Constructor Summary

Constructors

Constructor and Description
DefaultSubscriptionBaseApiService(org.killbill.clock.Clock clock, SubscriptionDao dao, CatalogService catalogService, PlanAligner planAligner, AddonUtils addonUtils, InternalCallContextFactory internalCallContextFactory)

Method Summary

Modifier and Type	Method and Description
boolean	cancel(DefaultSubscriptionBase subscription, CallContext context)
boolean	cancelWithPolicy(DefaultSubscriptionBase subscription, BillingActionPolicy policy, int accountBillCycleDayLocal, CallContext context)
boolean	cancelWithPolicyNoValidation(Iterable<DefaultSubscriptionBase> subscriptions, BillingActionPolicy policy, int accountBillCycleDayLocal, InternalCallContext context)
boolean	cancelWithRequestedDate(DefaultSubscriptionBase subscription, org.joda.time.DateTime requestedDateWithMs, CallContext context)
org.joda.time.DateTime	changePlan(DefaultSubscriptionBase subscription, PlanSpecifier spec, List<PlanPhasePriceOverride> overrides, CallContext context)
org.joda.time.DateTime	changePlanWithPolicy(DefaultSubscriptionBase subscription, PlanSpecifier spec, List<PlanPhasePriceOverride> overrides, BillingActionPolicy policy, CallContext context)
org.joda.time.DateTime	changePlanWithRequestedDate(DefaultSubscriptionBase subscription, PlanSpecifier spec, List<PlanPhasePriceOverride> overrides, org.joda.time.DateTime requestedDateWithMs, CallContext context)
DefaultSubscriptionBase	createPlan(SubscriptionBuilder builder, Plan plan, PhaseType initialPhase, String realPriceList, org.joda.time.DateTime effectiveDate, org.joda.time.DateTime processedDate, CallContext context)
List<SubscriptionBaseWithAddOns>	createPlansWithAddOns(UUID accountId, Iterable<SubscriptionAndAddOnsSpecifier> subscriptionsAndAddOns, CallContext context)
org.joda.time.DateTime	dryRunChangePlan(DefaultSubscriptionBase subscription, PlanSpecifier spec, org.joda.time.DateTime requestedDateWithMs, BillingActionPolicy requestedPolicy, TenantContext context)
List<SubscriptionBaseEvent>	getEventsOnCancelPlan(DefaultSubscriptionBase subscription, org.joda.time.DateTime effectiveDate, org.joda.time.DateTime processedDate, boolean addCancellationAddOnForEventsIfRequired, InternalTenantContext internalTenantContext)
List<SubscriptionBaseEvent>	getEventsOnChangePlan(DefaultSubscriptionBase subscription, Plan newPlan, String newPriceList, org.joda.time.DateTime effectiveDate, org.joda.time.DateTime processedDate, boolean addCancellationAddOnForEventsIfRequired, InternalTenantContext internalTenantContext)
List<SubscriptionBaseEvent>	getEventsOnCreation(UUID bundleId, UUID subscriptionId, org.joda.time.DateTime alignStartDate, org.joda.time.DateTime bundleStartDate, Plan plan, PhaseType initialPhase, String realPriceList, org.joda.time.DateTime effectiveDate, org.joda.time.DateTime processedDate, InternalTenantContext internalTenantContext)
PlanChangeResult	getPlanChangeResult(DefaultSubscriptionBase subscription, PlanSpecifier toPlanPhase, org.joda.time.DateTime effectiveDate, TenantContext context)
int	handleBasePlanEvent(DefaultSubscriptionBase subscription, SubscriptionBaseEvent event, CallContext context)
boolean	uncancel(DefaultSubscriptionBase subscription, CallContext context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultSubscriptionBaseApiService

@Inject
public DefaultSubscriptionBaseApiService(org.killbill.clock.Clock clock,
                                                 SubscriptionDao dao,
                                                 CatalogService catalogService,
                                                 PlanAligner planAligner,
                                                 AddonUtils addonUtils,
                                                 InternalCallContextFactory internalCallContextFactory)

Method Detail

createPlan

public DefaultSubscriptionBase createPlan(SubscriptionBuilder builder,
                                          Plan plan,
                                          PhaseType initialPhase,
                                          String realPriceList,
                                          org.joda.time.DateTime effectiveDate,
                                          org.joda.time.DateTime processedDate,
                                          CallContext context)
                                   throws SubscriptionBaseApiException

Specified by:

createPlan in interface SubscriptionBaseApiService

Throws:

SubscriptionBaseApiException

createPlansWithAddOns

public List<SubscriptionBaseWithAddOns> createPlansWithAddOns(UUID accountId,
                                                              Iterable<SubscriptionAndAddOnsSpecifier> subscriptionsAndAddOns,
                                                              CallContext context)
                                                       throws SubscriptionBaseApiException

Specified by:

createPlansWithAddOns in interface SubscriptionBaseApiService

Throws:

SubscriptionBaseApiException

cancel

public boolean cancel(DefaultSubscriptionBase subscription,
                      CallContext context)
               throws SubscriptionBaseApiException

Specified by:

cancel in interface SubscriptionBaseApiService

Throws:

SubscriptionBaseApiException

cancelWithRequestedDate

public boolean cancelWithRequestedDate(DefaultSubscriptionBase subscription,
                                       org.joda.time.DateTime requestedDateWithMs,
                                       CallContext context)
                                throws SubscriptionBaseApiException

Specified by:

cancelWithRequestedDate in interface SubscriptionBaseApiService

Throws:

SubscriptionBaseApiException

cancelWithPolicy

public boolean cancelWithPolicy(DefaultSubscriptionBase subscription,
                                BillingActionPolicy policy,
                                int accountBillCycleDayLocal,
                                CallContext context)
                         throws SubscriptionBaseApiException

Specified by:

cancelWithPolicy in interface SubscriptionBaseApiService

Throws:

SubscriptionBaseApiException

cancelWithPolicyNoValidation

public boolean cancelWithPolicyNoValidation(Iterable<DefaultSubscriptionBase> subscriptions,
                                            BillingActionPolicy policy,
                                            int accountBillCycleDayLocal,
                                            InternalCallContext context)
                                     throws SubscriptionBaseApiException

Specified by:

cancelWithPolicyNoValidation in interface SubscriptionBaseApiService

Throws:

SubscriptionBaseApiException

uncancel

public boolean uncancel(DefaultSubscriptionBase subscription,
                        CallContext context)
                 throws SubscriptionBaseApiException

Specified by:

uncancel in interface SubscriptionBaseApiService

Throws:

SubscriptionBaseApiException

dryRunChangePlan

public org.joda.time.DateTime dryRunChangePlan(DefaultSubscriptionBase subscription,
                                               PlanSpecifier spec,
                                               @Nullable
                                               org.joda.time.DateTime requestedDateWithMs,
                                               @Nullable
                                               BillingActionPolicy requestedPolicy,
                                               TenantContext context)
                                        throws SubscriptionBaseApiException

Specified by:

dryRunChangePlan in interface SubscriptionBaseApiService

Throws:

SubscriptionBaseApiException

changePlan

public org.joda.time.DateTime changePlan(DefaultSubscriptionBase subscription,
                                         PlanSpecifier spec,
                                         List<PlanPhasePriceOverride> overrides,
                                         CallContext context)
                                  throws SubscriptionBaseApiException

Specified by:

changePlan in interface SubscriptionBaseApiService

Throws:

SubscriptionBaseApiException

changePlanWithRequestedDate

public org.joda.time.DateTime changePlanWithRequestedDate(DefaultSubscriptionBase subscription,
                                                          PlanSpecifier spec,
                                                          List<PlanPhasePriceOverride> overrides,
                                                          org.joda.time.DateTime requestedDateWithMs,
                                                          CallContext context)
                                                   throws SubscriptionBaseApiException

Specified by:

changePlanWithRequestedDate in interface SubscriptionBaseApiService

Throws:

SubscriptionBaseApiException

changePlanWithPolicy

public org.joda.time.DateTime changePlanWithPolicy(DefaultSubscriptionBase subscription,
                                                   PlanSpecifier spec,
                                                   List<PlanPhasePriceOverride> overrides,
                                                   BillingActionPolicy policy,
                                                   CallContext context)
                                            throws SubscriptionBaseApiException

Specified by:

changePlanWithPolicy in interface SubscriptionBaseApiService

Throws:

SubscriptionBaseApiException

getPlanChangeResult

public PlanChangeResult getPlanChangeResult(DefaultSubscriptionBase subscription,
                                            PlanSpecifier toPlanPhase,
                                            org.joda.time.DateTime effectiveDate,
                                            TenantContext context)
                                     throws SubscriptionBaseApiException

Specified by:

getPlanChangeResult in interface SubscriptionBaseApiService

Throws:

SubscriptionBaseApiException

getEventsOnCreation

public List<SubscriptionBaseEvent> getEventsOnCreation(UUID bundleId,
                                                       UUID subscriptionId,
                                                       org.joda.time.DateTime alignStartDate,
                                                       org.joda.time.DateTime bundleStartDate,
                                                       Plan plan,
                                                       PhaseType initialPhase,
                                                       String realPriceList,
                                                       org.joda.time.DateTime effectiveDate,
                                                       org.joda.time.DateTime processedDate,
                                                       InternalTenantContext internalTenantContext)
                                                throws CatalogApiException,
                                                       SubscriptionBaseApiException

Specified by:

getEventsOnCreation in interface SubscriptionBaseApiService

Throws:

CatalogApiException

SubscriptionBaseApiException

getEventsOnChangePlan

public List<SubscriptionBaseEvent> getEventsOnChangePlan(DefaultSubscriptionBase subscription,
                                                         Plan newPlan,
                                                         String newPriceList,
                                                         org.joda.time.DateTime effectiveDate,
                                                         org.joda.time.DateTime processedDate,
                                                         boolean addCancellationAddOnForEventsIfRequired,
                                                         InternalTenantContext internalTenantContext)
                                                  throws CatalogApiException,
                                                         SubscriptionBaseApiException

Specified by:

getEventsOnChangePlan in interface SubscriptionBaseApiService

Throws:

CatalogApiException

SubscriptionBaseApiException

getEventsOnCancelPlan

public List<SubscriptionBaseEvent> getEventsOnCancelPlan(DefaultSubscriptionBase subscription,
                                                         org.joda.time.DateTime effectiveDate,
                                                         org.joda.time.DateTime processedDate,
                                                         boolean addCancellationAddOnForEventsIfRequired,
                                                         InternalTenantContext internalTenantContext)
                                                  throws CatalogApiException

Specified by:

getEventsOnCancelPlan in interface SubscriptionBaseApiService

Throws:

CatalogApiException

handleBasePlanEvent

public int handleBasePlanEvent(DefaultSubscriptionBase subscription,
                               SubscriptionBaseEvent event,
                               CallContext context)
                        throws CatalogApiException

Specified by:

handleBasePlanEvent in interface SubscriptionBaseApiService

Throws:

CatalogApiException