org.killbill.billing.catalog.api

Interface Plan

All Superinterfaces:

CatalogEntity

All Known Subinterfaces:

MigrationPlan

public interface Plan
extends CatalogEntity

The interface Plan

Method Summary

Modifier and Type	Method and Description
org.joda.time.DateTime	dateOfFirstRecurringNonZeroCharge(org.joda.time.DateTime subscriptionStartDate, PhaseType intialPhaseType)
PlanPhase	findPhase(java.lang.String name)
PlanPhase[]	getAllPhases()
StaticCatalog	getCatalog()
java.util.Date	getEffectiveDateForExistingSubscriptions()
PlanPhase	getFinalPhase()
java.util.Iterator<PlanPhase>	getInitialPhaseIterator()
PlanPhase[]	getInitialPhases()
int	getPlansAllowedInBundle()
java.lang.String	getPriceListName()
Product	getProduct()
BillingMode	getRecurringBillingMode()
BillingPeriod	getRecurringBillingPeriod()

Methods inherited from interface org.killbill.billing.catalog.api.CatalogEntity

getName, getPrettyName

Method Detail

getCatalog

StaticCatalog getCatalog()

Returns:

the catalog this plan belongs to

getRecurringBillingMode

BillingMode getRecurringBillingMode()

Returns:

the recurring billing mode for this catalog

getInitialPhases

PlanPhase[] getInitialPhases()

Returns:

an array of PlanPhase

getProduct

Product getProduct()

Returns:

the Product associated with that Plan

getPriceListName

java.lang.String getPriceListName()

Returns:

the name of the in which that Plan is defined

getInitialPhaseIterator

java.util.Iterator<PlanPhase> getInitialPhaseIterator()

Returns:

an iterator through the PlanPhase

getFinalPhase

PlanPhase getFinalPhase()

Returns:

the final PlanPhase

getRecurringBillingPeriod

BillingPeriod getRecurringBillingPeriod()

Returns:

the BillingPeriod

getPlansAllowedInBundle

int getPlansAllowedInBundle()

Returns:

the number of instance of subscriptions in a bundle with that Plan

getAllPhases

PlanPhase[] getAllPhases()

Returns:

an array of PlanPhase

getEffectiveDateForExistingSubscriptions

java.util.Date getEffectiveDateForExistingSubscriptions()

Returns:

the date for which existing subscriptions become effective with that Plan

findPhase

PlanPhase findPhase(java.lang.String name)
             throws CatalogApiException

Parameters:

name - the name of the PlanPhase

Returns:

the PlanPhase

Throws:

CatalogApiException - if there is not such PlanPhase

dateOfFirstRecurringNonZeroCharge

org.joda.time.DateTime dateOfFirstRecurringNonZeroCharge(org.joda.time.DateTime subscriptionStartDate,
                                                         PhaseType intialPhaseType)

Parameters:

subscriptionStartDate - the subscriptionStartDate

intialPhaseType - the type of the initial phase

Returns:

the date at which we see the first recurring non zero charge