org.killbill.billing.subscription.api

Interface SubscriptionBaseApiService

All Known Implementing Classes:

DefaultSubscriptionBaseApiService

public interface SubscriptionBaseApiService

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 requestedDate, 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 requestedDate, CallContext context)
java.util.List<SubscriptionBaseWithAddOns>	createPlansWithAddOns(java.util.UUID accountId, java.lang.Iterable<SubscriptionAndAddOnsSpecifier> subscriptionsAndAddOns, Catalog catalog, CallContext context)
org.joda.time.DateTime	dryRunChangePlan(DefaultSubscriptionBase subscription, EntitlementSpecifier spec, org.joda.time.DateTime requestedDate, BillingActionPolicy policy, 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 context)
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 context)
PlanChangeResult	getPlanChangeResult(DefaultSubscriptionBase subscription, PlanSpecifier spec, org.joda.time.DateTime effectiveDate, TenantContext context)
int	handleBasePlanEvent(DefaultSubscriptionBase subscription, SubscriptionBaseEvent event, Catalog fullCatalog, CallContext context)
boolean	uncancel(DefaultSubscriptionBase subscription, CallContext context)
boolean	undoChangePlan(DefaultSubscriptionBase defaultSubscriptionBase, CallContext context)

Method Detail

createPlansWithAddOns

java.util.List<SubscriptionBaseWithAddOns> createPlansWithAddOns(java.util.UUID accountId,
                                                                 java.lang.Iterable<SubscriptionAndAddOnsSpecifier> subscriptionsAndAddOns,
                                                                 Catalog catalog,
                                                                 CallContext context)
                                                          throws SubscriptionBaseApiException

Throws:

SubscriptionBaseApiException

cancel

boolean cancel(DefaultSubscriptionBase subscription,
               CallContext context)
        throws SubscriptionBaseApiException

Throws:

SubscriptionBaseApiException

cancelWithRequestedDate

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

Throws:

SubscriptionBaseApiException

cancelWithPolicy

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

Throws:

SubscriptionBaseApiException

cancelWithPolicyNoValidationAndCatalog

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

Throws:

SubscriptionBaseApiException

uncancel

boolean uncancel(DefaultSubscriptionBase subscription,
                 CallContext context)
          throws SubscriptionBaseApiException

Throws:

SubscriptionBaseApiException

dryRunChangePlan

org.joda.time.DateTime dryRunChangePlan(DefaultSubscriptionBase subscription,
                                        EntitlementSpecifier spec,
                                        org.joda.time.DateTime requestedDate,
                                        BillingActionPolicy policy,
                                        TenantContext context)
                                 throws SubscriptionBaseApiException

Throws:

SubscriptionBaseApiException

changePlan

org.joda.time.DateTime changePlan(DefaultSubscriptionBase subscription,
                                  EntitlementSpecifier spec,
                                  CallContext context)
                           throws SubscriptionBaseApiException

Throws:

SubscriptionBaseApiException

changePlanWithRequestedDate

org.joda.time.DateTime changePlanWithRequestedDate(DefaultSubscriptionBase subscription,
                                                   EntitlementSpecifier spec,
                                                   org.joda.time.DateTime requestedDate,
                                                   CallContext context)
                                            throws SubscriptionBaseApiException

Throws:

SubscriptionBaseApiException

changePlanWithPolicy

org.joda.time.DateTime changePlanWithPolicy(DefaultSubscriptionBase subscription,
                                            EntitlementSpecifier spec,
                                            BillingActionPolicy policy,
                                            CallContext context)
                                     throws SubscriptionBaseApiException

Throws:

SubscriptionBaseApiException

handleBasePlanEvent

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

Throws:

CatalogApiException

getPlanChangeResult

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

Throws:

SubscriptionBaseApiException

getEventsOnCreation

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 context)
                                                   throws CatalogApiException,
                                                          SubscriptionBaseApiException

Throws:

CatalogApiException

SubscriptionBaseApiException

getEventsOnChangePlan

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 context)
                                                     throws CatalogApiException,
                                                            SubscriptionBaseApiException

Throws:

CatalogApiException

SubscriptionBaseApiException

getEventsOnCancelPlan

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

Throws:

CatalogApiException

undoChangePlan

boolean undoChangePlan(DefaultSubscriptionBase defaultSubscriptionBase,
                       CallContext context)
                throws SubscriptionBaseApiException

Throws:

SubscriptionBaseApiException