Plan (Kill Bill apis 0.10.0 API)

All Known Subinterfaces:

MigrationPlan
```
public interface Plan
```
The interface Plan

Method Summary

Methods
Modifier and Type	Method and Description
`org.joda.time.DateTime`	`dateOfFirstRecurringNonZeroCharge(org.joda.time.DateTime subscriptionStartDate, PhaseType intialPhaseType)`
`PlanPhase`	`findPhase(String name)`
`PlanPhase[]`	`getAllPhases()`
`Date`	`getEffectiveDateForExistingSubscriptons()`
`PlanPhase`	`getFinalPhase()`
`Iterator<PlanPhase>`	`getInitialPhaseIterator()`
`PlanPhase[]`	`getInitialPhases()`
`String`	`getName()`
`int`	`getPlansAllowedInBundle()`
`Product`	`getProduct()`
`BillingPeriod`	`getRecurringBillingPeriod()`
`boolean`	`isRetired()`

- Method Detail
  - getInitialPhases
```
PlanPhase[] getInitialPhases()
```
    Returns:
    an array of PlanPhase
  - getProduct
```
Product getProduct()
```
    Returns:
    the Product associated with that Plan
  - getName
```
String getName()
```
    Returns:
    the name of the Plan
  - isRetired
```
boolean isRetired()
```
    Returns:
    whether the Plan has been retired
  - getInitialPhaseIterator
```
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
  - getEffectiveDateForExistingSubscriptons
```
Date getEffectiveDateForExistingSubscriptons()
```
    Returns:
    the date for which existing subscriptions become effective with that Plan
  - findPhase
```
PlanPhase findPhase(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

Interface Plan

Method Summary

Method Detail

getInitialPhases

getProduct

getName

isRetired

getInitialPhaseIterator

getFinalPhase

getRecurringBillingPeriod

getPlansAllowedInBundle

getAllPhases

getEffectiveDateForExistingSubscriptons

findPhase

dateOfFirstRecurringNonZeroCharge