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 java.lang.Object
implements SubscriptionBaseApiService

Constructor Summary

Constructors

Constructor and Description
DefaultSubscriptionBaseApiService(org.killbill.clock.Clock clock, SubscriptionDao dao, CatalogInternalApi catalogInternalApi, 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	cancelWithPolicyNoValidationAndCatalog(java.lang.Iterable<DefaultSubscriptionBase> subscriptions, BillingActionPolicy policy, int accountBillCycleDayLocal, Catalog catalog, InternalCallContext context)
boolean	cancelWithRequestedDate(DefaultSubscriptionBase subscription, org.joda.time.DateTime requestedDateWithMs, CallContext context)
org.joda.time.DateTime	changePlan(DefaultSubscriptionBase subscription, EntitlementSpecifier spec, CallContext context)
org.joda.time.DateTime	changePlanWithPolicy(DefaultSubscriptionBase subscription, EntitlementSpecifier spec, BillingActionPolicy policy, CallContext context)
org.joda.time.DateTime	changePlanWithRequestedDate(DefaultSubscriptionBase subscription, EntitlementSpecifier spec, org.joda.time.DateTime requestedDateWithMs, CallContext context)
java.util.List<SubscriptionBaseWithAddOns>	createPlansWithAddOns(java.util.UUID accountId, java.lang.Iterable<SubscriptionAndAddOnsSpecifier> subscriptionsAndAddOns, Catalog fullCatalog, CallContext context)
org.joda.time.DateTime	dryRunChangePlan(DefaultSubscriptionBase subscription, EntitlementSpecifier spec, org.joda.time.DateTime requestedDateWithMs, BillingActionPolicy requestedPolicy, TenantContext context)
java.util.List<SubscriptionBaseEvent>	getEventsOnCancelPlan(DefaultSubscriptionBase subscription, org.joda.time.DateTime effectiveDate, boolean addCancellationAddOnForEventsIfRequired, Catalog fullCatalog, InternalTenantContext internalTenantContext)
java.util.List<SubscriptionBaseEvent>	getEventsOnChangePlan(DefaultSubscriptionBase subscription, Plan newPlan, java.lang.String newPriceList, org.joda.time.DateTime effectiveDate, boolean addCancellationAddOnForEventsIfRequired, java.lang.Integer bcd, Catalog fullCatalog, InternalTenantContext internalTenantContext)
java.util.List<SubscriptionBaseEvent>	getEventsOnCreation(java.util.UUID subscriptionId, org.joda.time.DateTime alignStartDate, org.joda.time.DateTime bundleStartDate, Plan plan, PhaseType initialPhase, java.lang.String realPriceList, org.joda.time.DateTime effectiveDate, java.lang.Integer bcd, Catalog fullCatalog, InternalTenantContext internalTenantContext)
PlanChangeResult	getPlanChangeResult(DefaultSubscriptionBase subscription, PlanSpecifier toPlanPhase, org.joda.time.DateTime effectiveDate, TenantContext context)
int	handleBasePlanEvent(DefaultSubscriptionBase subscription, SubscriptionBaseEvent event, Catalog catalog, CallContext context)
boolean	uncancel(DefaultSubscriptionBase subscription, CallContext context)
boolean	undoChangePlan(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,
                                                 CatalogInternalApi catalogInternalApi,
                                                 PlanAligner planAligner,
                                                 AddonUtils addonUtils,
                                                 InternalCallContextFactory internalCallContextFactory)

Method Detail

createPlansWithAddOns

public java.util.List<SubscriptionBaseWithAddOns> createPlansWithAddOns(java.util.UUID accountId,
                                                                        java.lang.Iterable<SubscriptionAndAddOnsSpecifier> subscriptionsAndAddOns,
                                                                        Catalog fullCatalog,
                                                                        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

cancelWithPolicyNoValidationAndCatalog

public boolean cancelWithPolicyNoValidationAndCatalog(java.lang.Iterable<DefaultSubscriptionBase> subscriptions,
                                                      BillingActionPolicy policy,
                                                      int accountBillCycleDayLocal,
                                                      Catalog catalog,
                                                      InternalCallContext context)
                                               throws SubscriptionBaseApiException

Specified by:

cancelWithPolicyNoValidationAndCatalog 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,
                                               EntitlementSpecifier 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,
                                         EntitlementSpecifier spec,
                                         CallContext context)
                                  throws SubscriptionBaseApiException

Specified by:

changePlan in interface SubscriptionBaseApiService

Throws:

SubscriptionBaseApiException

changePlanWithRequestedDate

public org.joda.time.DateTime changePlanWithRequestedDate(DefaultSubscriptionBase subscription,
                                                          EntitlementSpecifier spec,
                                                          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,
                                                   EntitlementSpecifier spec,
                                                   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 java.util.List<SubscriptionBaseEvent> getEventsOnCreation(java.util.UUID subscriptionId,
                                                                 org.joda.time.DateTime alignStartDate,
                                                                 org.joda.time.DateTime bundleStartDate,
                                                                 Plan plan,
                                                                 PhaseType initialPhase,
                                                                 java.lang.String realPriceList,
                                                                 org.joda.time.DateTime effectiveDate,
                                                                 java.lang.Integer bcd,
                                                                 Catalog fullCatalog,
                                                                 InternalTenantContext internalTenantContext)
                                                          throws CatalogApiException,
                                                                 SubscriptionBaseApiException

Specified by:

getEventsOnCreation in interface SubscriptionBaseApiService

Throws:

CatalogApiException

SubscriptionBaseApiException

getEventsOnChangePlan

public java.util.List<SubscriptionBaseEvent> getEventsOnChangePlan(DefaultSubscriptionBase subscription,
                                                                   Plan newPlan,
                                                                   java.lang.String newPriceList,
                                                                   org.joda.time.DateTime effectiveDate,
                                                                   boolean addCancellationAddOnForEventsIfRequired,
                                                                   java.lang.Integer bcd,
                                                                   Catalog fullCatalog,
                                                                   InternalTenantContext internalTenantContext)
                                                            throws CatalogApiException,
                                                                   SubscriptionBaseApiException

Specified by:

getEventsOnChangePlan in interface SubscriptionBaseApiService

Throws:

CatalogApiException

SubscriptionBaseApiException

getEventsOnCancelPlan

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

Specified by:

getEventsOnCancelPlan in interface SubscriptionBaseApiService

Throws:

CatalogApiException

undoChangePlan

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

Specified by:

undoChangePlan in interface SubscriptionBaseApiService

Throws:

SubscriptionBaseApiException

handleBasePlanEvent

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

Specified by:

handleBasePlanEvent in interface SubscriptionBaseApiService

Throws:

CatalogApiException