org.killbill.billing.subscription.alignment

Class PlanAligner

java.lang.Object

org.killbill.billing.subscription.alignment.BaseAligner

org.killbill.billing.subscription.alignment.PlanAligner

public class PlanAligner
extends BaseAligner

PlanAligner offers specific APIs to return the correct TimedPhase when creating, changing Plan or to compute next Phase on current Plan.

Constructor Summary

Constructors

Constructor and Description
PlanAligner()

Method Summary

Modifier and Type	Method and Description
TimedPhase[]	getCurrentAndNextTimedPhaseOnCreate(org.joda.time.DateTime alignStartDate, org.joda.time.DateTime bundleStartDate, Plan plan, PhaseType initialPhase, java.lang.String priceList, org.joda.time.DateTime effectiveDate, Catalog catalog, InternalTenantContext context) Returns the current and next phase for the subscription in creation
TimedPhase	getCurrentTimedPhaseOnChange(DefaultSubscriptionBase subscription, Plan plan, org.joda.time.DateTime effectiveDate, PhaseType newPlanInitialPhaseType, Catalog catalog, InternalTenantContext context) Returns current Phase for that Plan change
TimedPhase	getNextTimedPhase(DefaultSubscriptionBase subscription, org.joda.time.DateTime effectiveDate, Catalog catalog, InternalTenantContext context) Returns next Phase for that SubscriptionBase at a point in time
TimedPhase	getNextTimedPhaseOnChange(DefaultSubscriptionBase subscription, Plan plan, org.joda.time.DateTime effectiveDate, PhaseType newPlanInitialPhaseType, Catalog catalog, InternalTenantContext context) Returns next Phase for that Plan change

Methods inherited from class org.killbill.billing.subscription.alignment.BaseAligner

addDuration, removeDuration

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanAligner

@Inject
public PlanAligner()

Method Detail

getCurrentAndNextTimedPhaseOnCreate

public TimedPhase[] getCurrentAndNextTimedPhaseOnCreate(org.joda.time.DateTime alignStartDate,
                                                        org.joda.time.DateTime bundleStartDate,
                                                        Plan plan,
                                                        @Nullable
                                                        PhaseType initialPhase,
                                                        java.lang.String priceList,
                                                        org.joda.time.DateTime effectiveDate,
                                                        Catalog catalog,
                                                        InternalTenantContext context)
                                                 throws CatalogApiException,
                                                        SubscriptionBaseApiException

Returns the current and next phase for the subscription in creation

Parameters:

alignStartDate - the subscription (align) startDate for the subscription

bundleStartDate - the bundle startDate used alignment

plan - the current Plan

initialPhase - the initialPhase on which we should create that subscription. can be null

priceList - the priceList

effectiveDate - the effective creation date (driven by the catalog policy, i.e. when the creation occurs)

Returns:

the current and next phases

Throws:

CatalogApiException - for catalog errors

SubscriptionBaseApiException - for subscription errors

getCurrentTimedPhaseOnChange

public TimedPhase getCurrentTimedPhaseOnChange(DefaultSubscriptionBase subscription,
                                               Plan plan,
                                               org.joda.time.DateTime effectiveDate,
                                               PhaseType newPlanInitialPhaseType,
                                               Catalog catalog,
                                               InternalTenantContext context)
                                        throws CatalogApiException,
                                               SubscriptionBaseApiException

Returns current Phase for that Plan change

Parameters:

subscription - the subscription in change (only start date, bundle start date, current phase, plan and pricelist are looked at)

plan - the current Plan

effectiveDate - the effective change date (driven by the catalog policy, i.e. when the change occurs)

newPlanInitialPhaseType - the phase on which to start when switching to new plan

Returns:

the current phase

Throws:

CatalogApiException - for catalog errors

SubscriptionBaseApiException - for subscription errors

getNextTimedPhaseOnChange

public TimedPhase getNextTimedPhaseOnChange(DefaultSubscriptionBase subscription,
                                            Plan plan,
                                            org.joda.time.DateTime effectiveDate,
                                            PhaseType newPlanInitialPhaseType,
                                            Catalog catalog,
                                            InternalTenantContext context)
                                     throws CatalogApiException,
                                            SubscriptionBaseApiException

Returns next Phase for that Plan change

Parameters:

subscription - the subscription in change (only start date, bundle start date, current phase, plan and pricelist are looked at)

plan - the current Plan

effectiveDate - the effective change date (driven by the catalog policy, i.e. when the change occurs)

newPlanInitialPhaseType - the phase on which to start when switching to new plan

Returns:

the next phase

Throws:

CatalogApiException - for catalog errors

SubscriptionBaseApiException - for subscription errors

getNextTimedPhase

public TimedPhase getNextTimedPhase(DefaultSubscriptionBase subscription,
                                    org.joda.time.DateTime effectiveDate,
                                    Catalog catalog,
                                    InternalTenantContext context)

Returns next Phase for that SubscriptionBase at a point in time

Parameters:

subscription - the subscription for which we need to compute the next Phase event

Returns:

the next phase