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	cancelWithPolicyNoValidation(Iterable<DefaultSubscriptionBase> subscriptions, BillingActionPolicy policy, int accountBillCycleDayLocal, InternalCallContext context)
boolean	cancelWithRequestedDate(DefaultSubscriptionBase subscription, org.joda.time.DateTime requestedDate, 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 requestedDate, 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 requestedDate, BillingActionPolicy policy, 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 context)
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 context)
PlanChangeResult	getPlanChangeResult(DefaultSubscriptionBase subscription, PlanSpecifier spec, org.joda.time.DateTime effectiveDate, TenantContext context)
int	handleBasePlanEvent(DefaultSubscriptionBase subscription, SubscriptionBaseEvent event, CallContext context)
boolean	uncancel(DefaultSubscriptionBase subscription, CallContext context)

Method Detail

createPlan

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

Throws:

SubscriptionBaseApiException

createPlansWithAddOns

List<SubscriptionBaseWithAddOns> createPlansWithAddOns(UUID accountId,
                                                       Iterable<SubscriptionAndAddOnsSpecifier> subscriptionsAndAddOns,
                                                       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

cancelWithPolicyNoValidation

boolean cancelWithPolicyNoValidation(Iterable<DefaultSubscriptionBase> subscriptions,
                                     BillingActionPolicy policy,
                                     int accountBillCycleDayLocal,
                                     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,
                                        PlanSpecifier spec,
                                        org.joda.time.DateTime requestedDate,
                                        BillingActionPolicy policy,
                                        TenantContext context)
                                 throws SubscriptionBaseApiException

Throws:

SubscriptionBaseApiException

changePlan

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

Throws:

SubscriptionBaseApiException

changePlanWithRequestedDate

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

Throws:

SubscriptionBaseApiException

changePlanWithPolicy

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

Throws:

SubscriptionBaseApiException

handleBasePlanEvent

int handleBasePlanEvent(DefaultSubscriptionBase subscription,
                        SubscriptionBaseEvent event,
                        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

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

Throws:

CatalogApiException

SubscriptionBaseApiException

getEventsOnChangePlan

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

Throws:

CatalogApiException

SubscriptionBaseApiException

getEventsOnCancelPlan

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

Throws:

CatalogApiException