org.killbill.billing.subscription.api.user

Class DefaultSubscriptionBase

java.lang.Object

org.killbill.billing.entity.EntityBase

org.killbill.billing.subscription.api.user.DefaultSubscriptionBase

All Implemented Interfaces:

Blockable, SubscriptionBase, Entity

public class DefaultSubscriptionBase
extends EntityBase
implements SubscriptionBase

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<SubscriptionBaseEvent>	events

Fields inherited from class org.killbill.billing.entity.EntityBase

createdDate, id, updatedDate

Constructor Summary

Constructors

Constructor and Description
DefaultSubscriptionBase(DefaultSubscriptionBase internalSubscription, SubscriptionBaseApiService apiService, org.killbill.clock.Clock clock)
DefaultSubscriptionBase(SubscriptionBuilder builder)
DefaultSubscriptionBase(SubscriptionBuilder builder, SubscriptionBaseApiService apiService, org.killbill.clock.Clock clock)

Method Summary

Modifier and Type	Method and Description
boolean	cancel(CallContext context)
boolean	cancelWithDate(org.joda.time.DateTime requestedDate, CallContext context)
boolean	cancelWithPolicy(BillingActionPolicy policy, int accountBillCycleDayLocal, CallContext context)
org.joda.time.DateTime	changePlan(EntitlementSpecifier spec, CallContext context)
org.joda.time.DateTime	changePlanWithDate(EntitlementSpecifier spec, org.joda.time.DateTime requestedDate, CallContext context)
org.joda.time.DateTime	changePlanWithPolicy(EntitlementSpecifier spec, BillingActionPolicy policy, CallContext context)
boolean	equals(java.lang.Object obj)
org.joda.time.DateTime	getAlignStartDate()
java.util.List<SubscriptionBaseTransition>	getAllTransitions()
java.lang.Integer	getBillCycleDayLocal()
java.util.List<SubscriptionBaseTransition>	getBillingTransitions()
java.lang.String	getBundleExternalKey()
java.util.UUID	getBundleId()
org.joda.time.DateTime	getBundleStartDate()
ProductCategory	getCategory()
org.joda.time.DateTime	getChargedThroughDate()
PlanPhase	getCurrentOrPendingPhase()
Plan	getCurrentOrPendingPlan()
PlanPhase	getCurrentPhase()
org.joda.time.DateTime	getCurrentPhaseStart()
Plan	getCurrentPlan()
PriceList	getCurrentPriceList()
org.joda.time.DateTime	getDateOfFirstRecurringNonZeroCharge()
org.joda.time.DateTime	getEndDate()
java.util.List<SubscriptionBaseEvent>	getEvents()
org.joda.time.DateTime	getFutureEndDate()
BillingPeriod	getLastActiveBillingPeriod()
ProductCategory	getLastActiveCategory()
PlanPhase	getLastActivePhase()
Plan	getLastActivePlan()
PriceList	getLastActivePriceList()
Product	getLastActiveProduct()
long	getLastEventOrderedId()
SubscriptionBaseTransitionData	getLastTransitionForCurrentPlan()
SubscriptionBaseTransition	getPendingTransition()
org.joda.time.DateTime	getPlanChangeEffectiveDate(BillingActionPolicy policy, BillingAlignment alignment, java.lang.Integer accountBillCycleDayLocal, InternalTenantContext context)
SubscriptionBaseTransition	getPreviousTransition()
Entitlement.EntitlementSourceType	getSourceType()
org.joda.time.DateTime	getStartDate()
Entitlement.EntitlementState	getState()
SubscriptionBaseTransitionData	getTransitionFromEvent(SubscriptionBaseEvent event, int seqId)
int	hashCode()
boolean	isFutureCancelled()
boolean	isMigrated()
boolean	isPendingChangePlan()
void	rebuildTransitions(java.util.List<SubscriptionBaseEvent> inputEvents, Catalog catalog)
boolean	uncancel(CallContext context)
boolean	undoChangePlan(CallContext context)

Methods inherited from class org.killbill.billing.entity.EntityBase

getCreatedDate, getId, getUpdatedDate, safeCompareTo, setCreatedDate, setId, setUpdatedDate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.killbill.billing.util.entity.Entity

getCreatedDate, getId, getUpdatedDate

Field Detail

events

protected java.util.List<SubscriptionBaseEvent> events

Constructor Detail

DefaultSubscriptionBase

public DefaultSubscriptionBase(SubscriptionBuilder builder)

DefaultSubscriptionBase

public DefaultSubscriptionBase(SubscriptionBuilder builder,
                               @Nullable
                               SubscriptionBaseApiService apiService,
                               @Nullable
                               org.killbill.clock.Clock clock)

DefaultSubscriptionBase

public DefaultSubscriptionBase(DefaultSubscriptionBase internalSubscription,
                               SubscriptionBaseApiService apiService,
                               org.killbill.clock.Clock clock)

Method Detail

getEvents

public java.util.List<SubscriptionBaseEvent> getEvents()

getBundleId

public java.util.UUID getBundleId()

Specified by:

getBundleId in interface SubscriptionBase

getBundleExternalKey

public java.lang.String getBundleExternalKey()

getStartDate

public org.joda.time.DateTime getStartDate()

Specified by:

getStartDate in interface SubscriptionBase

getState

public Entitlement.EntitlementState getState()

Specified by:

getState in interface SubscriptionBase

getSourceType

public Entitlement.EntitlementSourceType getSourceType()

Specified by:

getSourceType in interface SubscriptionBase

getCurrentPhase

public PlanPhase getCurrentPhase()

Specified by:

getCurrentPhase in interface SubscriptionBase

getCurrentOrPendingPhase

public PlanPhase getCurrentOrPendingPhase()

getCurrentPlan

public Plan getCurrentPlan()

Specified by:

getCurrentPlan in interface SubscriptionBase

getCurrentOrPendingPlan

public Plan getCurrentOrPendingPlan()

Specified by:

getCurrentOrPendingPlan in interface SubscriptionBase

getCurrentPriceList

public PriceList getCurrentPriceList()

Specified by:

getCurrentPriceList in interface SubscriptionBase

getEndDate

public org.joda.time.DateTime getEndDate()

Specified by:

getEndDate in interface SubscriptionBase

getFutureEndDate

public org.joda.time.DateTime getFutureEndDate()

Specified by:

getFutureEndDate in interface SubscriptionBase

cancel

public boolean cancel(CallContext context)
               throws SubscriptionBaseApiException

Specified by:

cancel in interface SubscriptionBase

Throws:

SubscriptionBaseApiException

cancelWithDate

public boolean cancelWithDate(org.joda.time.DateTime requestedDate,
                              CallContext context)
                       throws SubscriptionBaseApiException

Specified by:

cancelWithDate in interface SubscriptionBase

Throws:

SubscriptionBaseApiException

cancelWithPolicy

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

Specified by:

cancelWithPolicy in interface SubscriptionBase

Throws:

SubscriptionBaseApiException

uncancel

public boolean uncancel(CallContext context)
                 throws SubscriptionBaseApiException

Specified by:

uncancel in interface SubscriptionBase

Throws:

SubscriptionBaseApiException

changePlan

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

Specified by:

changePlan in interface SubscriptionBase

Throws:

SubscriptionBaseApiException

undoChangePlan

public boolean undoChangePlan(CallContext context)
                       throws SubscriptionBaseApiException

Specified by:

undoChangePlan in interface SubscriptionBase

Throws:

SubscriptionBaseApiException

changePlanWithDate

public org.joda.time.DateTime changePlanWithDate(EntitlementSpecifier spec,
                                                 org.joda.time.DateTime requestedDate,
                                                 CallContext context)
                                          throws SubscriptionBaseApiException

Specified by:

changePlanWithDate in interface SubscriptionBase

Throws:

SubscriptionBaseApiException

changePlanWithPolicy

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

Specified by:

changePlanWithPolicy in interface SubscriptionBase

Throws:

SubscriptionBaseApiException

getPendingTransition

public SubscriptionBaseTransition getPendingTransition()

Specified by:

getPendingTransition in interface SubscriptionBase

getLastActiveProduct

public Product getLastActiveProduct()

Specified by:

getLastActiveProduct in interface SubscriptionBase

getLastActivePriceList

public PriceList getLastActivePriceList()

Specified by:

getLastActivePriceList in interface SubscriptionBase

getLastActiveCategory

public ProductCategory getLastActiveCategory()

Specified by:

getLastActiveCategory in interface SubscriptionBase

getLastActivePlan

public Plan getLastActivePlan()

Specified by:

getLastActivePlan in interface SubscriptionBase

getLastActivePhase

public PlanPhase getLastActivePhase()

Specified by:

getLastActivePhase in interface SubscriptionBase

getLastActiveBillingPeriod

public BillingPeriod getLastActiveBillingPeriod()

Specified by:

getLastActiveBillingPeriod in interface SubscriptionBase

getPreviousTransition

public SubscriptionBaseTransition getPreviousTransition()

Specified by:

getPreviousTransition in interface SubscriptionBase

getCategory

public ProductCategory getCategory()

Specified by:

getCategory in interface SubscriptionBase

getBillCycleDayLocal

public java.lang.Integer getBillCycleDayLocal()

Specified by:

getBillCycleDayLocal in interface SubscriptionBase

getBundleStartDate

public org.joda.time.DateTime getBundleStartDate()

getChargedThroughDate

public org.joda.time.DateTime getChargedThroughDate()

Specified by:

getChargedThroughDate in interface SubscriptionBase

isMigrated

public boolean isMigrated()

Specified by:

isMigrated in interface SubscriptionBase

getAllTransitions

public java.util.List<SubscriptionBaseTransition> getAllTransitions()

Specified by:

getAllTransitions in interface SubscriptionBase

hashCode

public int hashCode()

Overrides:

hashCode in class EntityBase

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class EntityBase

getDateOfFirstRecurringNonZeroCharge

public org.joda.time.DateTime getDateOfFirstRecurringNonZeroCharge()

Specified by:

getDateOfFirstRecurringNonZeroCharge in interface SubscriptionBase

getTransitionFromEvent

public SubscriptionBaseTransitionData getTransitionFromEvent(SubscriptionBaseEvent event,
                                                             int seqId)

getAlignStartDate

public org.joda.time.DateTime getAlignStartDate()

getLastEventOrderedId

public long getLastEventOrderedId()

getBillingTransitions

public java.util.List<SubscriptionBaseTransition> getBillingTransitions()

getLastTransitionForCurrentPlan

public SubscriptionBaseTransitionData getLastTransitionForCurrentPlan()

isFutureCancelled

public boolean isFutureCancelled()

isPendingChangePlan

public boolean isPendingChangePlan()

getPlanChangeEffectiveDate

public org.joda.time.DateTime getPlanChangeEffectiveDate(BillingActionPolicy policy,
                                                         @Nullable
                                                         BillingAlignment alignment,
                                                         @Nullable
                                                         java.lang.Integer accountBillCycleDayLocal,
                                                         InternalTenantContext context)

getCurrentPhaseStart

public org.joda.time.DateTime getCurrentPhaseStart()

rebuildTransitions

public void rebuildTransitions(java.util.List<SubscriptionBaseEvent> inputEvents,
                               Catalog catalog)
                        throws CatalogApiException

Throws:

CatalogApiException