org.killbill.billing.catalog

Class VersionedCatalog

java.lang.Object

org.killbill.xmlloader.ValidatingConfig<VersionedCatalog>

org.killbill.billing.catalog.VersionedCatalog

All Implemented Interfaces:

Catalog, StaticCatalog

public class VersionedCatalog
extends org.killbill.xmlloader.ValidatingConfig<VersionedCatalog>
implements Catalog, StaticCatalog

Constructor Summary

Constructors

Constructor and Description
VersionedCatalog()
VersionedCatalog(org.killbill.clock.Clock clock)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(StandaloneCatalog e)
void	addAll(List<StandaloneCatalog> inputVersions)
BillingAlignment	billingAlignment(PlanPhaseSpecifier planPhase)
BillingAlignment	billingAlignment(PlanPhaseSpecifier planPhase, org.joda.time.DateTime requestedDate)
boolean	canCreatePlan(PlanSpecifier specifier)
boolean	canCreatePlan(PlanSpecifier specifier, org.joda.time.DateTime requestedDate)
boolean	compliesWithLimits(String phaseName, String unit, double value)
Plan	createOrFindCurrentPlan(PlanSpecifier spec, PlanPhasePriceOverridesWithCallContext overrides)
Plan	createOrFindPlan(PlanSpecifier spec, PlanPhasePriceOverridesWithCallContext overrides, org.joda.time.DateTime requestedDate)
Plan	createOrFindPlan(PlanSpecifier spec, PlanPhasePriceOverridesWithCallContext overrides, org.joda.time.DateTime requestedDate, org.joda.time.DateTime subscriptionStartDate)
PlanPhase	findCurrentPhase(String name)
Plan	findCurrentPlan(String name)
PriceList	findCurrentPricelist(String name)
Product	findCurrentProduct(String name)
PlanPhase	findPhase(String phaseName, org.joda.time.DateTime requestedDate, org.joda.time.DateTime subscriptionStartDate)
Plan	findPlan(String name, org.joda.time.DateTime requestedDate)
Plan	findPlan(String name, org.joda.time.DateTime requestedDate, org.joda.time.DateTime subscriptionStartDate)
PriceList	findPriceList(String name, org.joda.time.DateTime requestedDate)
PriceList	findPriceListForPlan(String planName, org.joda.time.DateTime requestedDate, org.joda.time.DateTime subscriptionStartDate)
Product	findProduct(String name, org.joda.time.DateTime requestedDate)
List<Listing>	getAvailableAddOnListings(String baseProductName, String priceListName)
List<Listing>	getAvailableBasePlanListings()
String	getCatalogName()
org.killbill.clock.Clock	getClock()
Collection<Plan>	getCurrentPlans()
Collection<Product>	getCurrentProducts()
Currency[]	getCurrentSupportedCurrencies()
Unit[]	getCurrentUnits()
Date	getEffectiveDate()
Collection<Plan>	getPlans(org.joda.time.DateTime requestedDate)
PriceListSet	getPriceLists(org.joda.time.DateTime requestedDate)
Collection<Product>	getProducts(org.joda.time.DateTime requestedDate)
BillingMode	getRecurringBillingMode()
Date	getStandaloneCatalogEffectiveDate(org.joda.time.DateTime requestedDate)
Currency[]	getSupportedCurrencies(org.joda.time.DateTime requestedDate)
List<StandaloneCatalog>	getVersions()
void	initialize(VersionedCatalog catalog, URI sourceURI)
Iterator<StandaloneCatalog>	iterator()
BillingActionPolicy	planCancelPolicy(PlanPhaseSpecifier planPhase)
BillingActionPolicy	planCancelPolicy(PlanPhaseSpecifier planPhase, org.joda.time.DateTime requestedDate)
PlanChangeResult	planChange(PlanPhaseSpecifier from, PlanSpecifier to)
PlanChangeResult	planChange(PlanPhaseSpecifier from, PlanSpecifier to, org.joda.time.DateTime requestedDate)
PlanAlignmentChange	planChangeAlignment(PlanPhaseSpecifier from, PlanSpecifier to)
PlanAlignmentChange	planChangeAlignment(PlanPhaseSpecifier from, PlanSpecifier to, org.joda.time.DateTime requestedDate)
BillingActionPolicy	planChangePolicy(PlanPhaseSpecifier from, PlanSpecifier to)
BillingActionPolicy	planChangePolicy(PlanPhaseSpecifier from, PlanSpecifier to, org.joda.time.DateTime requestedDate)
PlanAlignmentCreate	planCreateAlignment(PlanSpecifier specifier)
PlanAlignmentCreate	planCreateAlignment(PlanSpecifier specifier, org.joda.time.DateTime requestedDate)
int	size()
org.killbill.xmlloader.ValidationErrors	validate(VersionedCatalog catalog, org.killbill.xmlloader.ValidationErrors errors)

Methods inherited from class org.killbill.xmlloader.ValidatingConfig

validateCollection

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionedCatalog

public VersionedCatalog()

VersionedCatalog

public VersionedCatalog(org.killbill.clock.Clock clock)

Method Detail

getClock

public org.killbill.clock.Clock getClock()

getVersions

public List<StandaloneCatalog> getVersions()

addAll

public void addAll(List<StandaloneCatalog> inputVersions)
            throws CatalogApiException

Throws:

CatalogApiException

add

public void add(StandaloneCatalog e)
         throws CatalogApiException

Throws:

CatalogApiException

iterator

public Iterator<StandaloneCatalog> iterator()

size

public int size()

getCatalogName

public String getCatalogName()

Specified by:

getCatalogName in interface Catalog

Specified by:

getCatalogName in interface StaticCatalog

getProducts

public Collection<Product> getProducts(org.joda.time.DateTime requestedDate)
                                throws CatalogApiException

Specified by:

getProducts in interface Catalog

Throws:

CatalogApiException

getSupportedCurrencies

public Currency[] getSupportedCurrencies(org.joda.time.DateTime requestedDate)
                                  throws CatalogApiException

Specified by:

getSupportedCurrencies in interface Catalog

Throws:

CatalogApiException

getPlans

public Collection<Plan> getPlans(org.joda.time.DateTime requestedDate)
                          throws CatalogApiException

Specified by:

getPlans in interface Catalog

Throws:

CatalogApiException

getPriceLists

public PriceListSet getPriceLists(org.joda.time.DateTime requestedDate)
                           throws CatalogApiException

Specified by:

getPriceLists in interface Catalog

Throws:

CatalogApiException

findPlan

public Plan findPlan(String name,
            org.joda.time.DateTime requestedDate)
              throws CatalogApiException

Specified by:

findPlan in interface Catalog

Throws:

CatalogApiException

createOrFindPlan

public Plan createOrFindPlan(PlanSpecifier spec,
                    PlanPhasePriceOverridesWithCallContext overrides,
                    org.joda.time.DateTime requestedDate)
                      throws CatalogApiException

Specified by:

createOrFindPlan in interface Catalog

Throws:

CatalogApiException

findPlan

public Plan findPlan(String name,
            org.joda.time.DateTime requestedDate,
            org.joda.time.DateTime subscriptionStartDate)
              throws CatalogApiException

Specified by:

findPlan in interface Catalog

Throws:

CatalogApiException

createOrFindPlan

public Plan createOrFindPlan(PlanSpecifier spec,
                    PlanPhasePriceOverridesWithCallContext overrides,
                    org.joda.time.DateTime requestedDate,
                    org.joda.time.DateTime subscriptionStartDate)
                      throws CatalogApiException

Specified by:

createOrFindPlan in interface Catalog

Throws:

CatalogApiException

findProduct

public Product findProduct(String name,
                  org.joda.time.DateTime requestedDate)
                    throws CatalogApiException

Specified by:

findProduct in interface Catalog

Throws:

CatalogApiException

findPhase

public PlanPhase findPhase(String phaseName,
                  org.joda.time.DateTime requestedDate,
                  org.joda.time.DateTime subscriptionStartDate)
                    throws CatalogApiException

Specified by:

findPhase in interface Catalog

Throws:

CatalogApiException

findPriceListForPlan

public PriceList findPriceListForPlan(String planName,
                             org.joda.time.DateTime requestedDate,
                             org.joda.time.DateTime subscriptionStartDate)
                               throws CatalogApiException

Specified by:

findPriceListForPlan in interface Catalog

Throws:

CatalogApiException

findPriceList

public PriceList findPriceList(String name,
                      org.joda.time.DateTime requestedDate)
                        throws CatalogApiException

Specified by:

findPriceList in interface Catalog

Throws:

CatalogApiException

planChangePolicy

public BillingActionPolicy planChangePolicy(PlanPhaseSpecifier from,
                                   PlanSpecifier to,
                                   org.joda.time.DateTime requestedDate)
                                     throws CatalogApiException

Specified by:

planChangePolicy in interface Catalog

Throws:

CatalogApiException

planCancelPolicy

public BillingActionPolicy planCancelPolicy(PlanPhaseSpecifier planPhase,
                                   org.joda.time.DateTime requestedDate)
                                     throws CatalogApiException

Specified by:

planCancelPolicy in interface Catalog

Throws:

CatalogApiException

planChangeAlignment

public PlanAlignmentChange planChangeAlignment(PlanPhaseSpecifier from,
                                      PlanSpecifier to,
                                      org.joda.time.DateTime requestedDate)
                                        throws CatalogApiException

Specified by:

planChangeAlignment in interface Catalog

Throws:

CatalogApiException

planCreateAlignment

public PlanAlignmentCreate planCreateAlignment(PlanSpecifier specifier,
                                      org.joda.time.DateTime requestedDate)
                                        throws CatalogApiException

Specified by:

planCreateAlignment in interface Catalog

Throws:

CatalogApiException

billingAlignment

public BillingAlignment billingAlignment(PlanPhaseSpecifier planPhase,
                                org.joda.time.DateTime requestedDate)
                                  throws CatalogApiException

Specified by:

billingAlignment in interface Catalog

Throws:

CatalogApiException

planChange

public PlanChangeResult planChange(PlanPhaseSpecifier from,
                          PlanSpecifier to,
                          org.joda.time.DateTime requestedDate)
                            throws CatalogApiException

Specified by:

planChange in interface Catalog

Throws:

CatalogApiException

canCreatePlan

public boolean canCreatePlan(PlanSpecifier specifier,
                    org.joda.time.DateTime requestedDate)
                      throws CatalogApiException

Specified by:

canCreatePlan in interface Catalog

Throws:

CatalogApiException

initialize

public void initialize(VersionedCatalog catalog,
              URI sourceURI)

Overrides:

initialize in class org.killbill.xmlloader.ValidatingConfig<VersionedCatalog>

validate

public org.killbill.xmlloader.ValidationErrors validate(VersionedCatalog catalog,
                                               org.killbill.xmlloader.ValidationErrors errors)

Specified by:

validate in class org.killbill.xmlloader.ValidatingConfig<VersionedCatalog>

getEffectiveDate

public Date getEffectiveDate()
                      throws CatalogApiException

Specified by:

getEffectiveDate in interface StaticCatalog

Throws:

CatalogApiException

getStandaloneCatalogEffectiveDate

public Date getStandaloneCatalogEffectiveDate(org.joda.time.DateTime requestedDate)
                                       throws CatalogApiException

Specified by:

getStandaloneCatalogEffectiveDate in interface Catalog

Throws:

CatalogApiException

getRecurringBillingMode

public BillingMode getRecurringBillingMode()

Specified by:

getRecurringBillingMode in interface StaticCatalog

getCurrentSupportedCurrencies

public Currency[] getCurrentSupportedCurrencies()
                                         throws CatalogApiException

Specified by:

getCurrentSupportedCurrencies in interface StaticCatalog

Throws:

CatalogApiException

getCurrentProducts

public Collection<Product> getCurrentProducts()
                                       throws CatalogApiException

Specified by:

getCurrentProducts in interface StaticCatalog

Throws:

CatalogApiException

getCurrentUnits

public Unit[] getCurrentUnits()
                       throws CatalogApiException

Specified by:

getCurrentUnits in interface StaticCatalog

Throws:

CatalogApiException

getCurrentPlans

public Collection<Plan> getCurrentPlans()
                                 throws CatalogApiException

Specified by:

getCurrentPlans in interface StaticCatalog

Throws:

CatalogApiException

createOrFindCurrentPlan

public Plan createOrFindCurrentPlan(PlanSpecifier spec,
                           PlanPhasePriceOverridesWithCallContext overrides)
                             throws CatalogApiException

Specified by:

createOrFindCurrentPlan in interface StaticCatalog

Throws:

CatalogApiException

findCurrentPlan

public Plan findCurrentPlan(String name)
                     throws CatalogApiException

Specified by:

findCurrentPlan in interface StaticCatalog

Throws:

CatalogApiException

findCurrentProduct

public Product findCurrentProduct(String name)
                           throws CatalogApiException

Specified by:

findCurrentProduct in interface StaticCatalog

Throws:

CatalogApiException

findCurrentPhase

public PlanPhase findCurrentPhase(String name)
                           throws CatalogApiException

Specified by:

findCurrentPhase in interface StaticCatalog

Throws:

CatalogApiException

findCurrentPricelist

public PriceList findCurrentPricelist(String name)
                               throws CatalogApiException

Specified by:

findCurrentPricelist in interface StaticCatalog

Throws:

CatalogApiException

planChangePolicy

public BillingActionPolicy planChangePolicy(PlanPhaseSpecifier from,
                                   PlanSpecifier to)
                                     throws CatalogApiException

Specified by:

planChangePolicy in interface StaticCatalog

Throws:

CatalogApiException

planChange

public PlanChangeResult planChange(PlanPhaseSpecifier from,
                          PlanSpecifier to)
                            throws CatalogApiException

Specified by:

planChange in interface StaticCatalog

Throws:

CatalogApiException

planCancelPolicy

public BillingActionPolicy planCancelPolicy(PlanPhaseSpecifier planPhase)
                                     throws CatalogApiException

Specified by:

planCancelPolicy in interface StaticCatalog

Throws:

CatalogApiException

planCreateAlignment

public PlanAlignmentCreate planCreateAlignment(PlanSpecifier specifier)
                                        throws CatalogApiException

Specified by:

planCreateAlignment in interface StaticCatalog

Throws:

CatalogApiException

billingAlignment

public BillingAlignment billingAlignment(PlanPhaseSpecifier planPhase)
                                  throws CatalogApiException

Specified by:

billingAlignment in interface StaticCatalog

Throws:

CatalogApiException

planChangeAlignment

public PlanAlignmentChange planChangeAlignment(PlanPhaseSpecifier from,
                                      PlanSpecifier to)
                                        throws CatalogApiException

Specified by:

planChangeAlignment in interface StaticCatalog

Throws:

CatalogApiException

canCreatePlan

public boolean canCreatePlan(PlanSpecifier specifier)
                      throws CatalogApiException

Specified by:

canCreatePlan in interface StaticCatalog

Throws:

CatalogApiException

getAvailableAddOnListings

public List<Listing> getAvailableAddOnListings(String baseProductName,
                                      @Nullable
                                      String priceListName)
                                        throws CatalogApiException

Specified by:

getAvailableAddOnListings in interface StaticCatalog

Throws:

CatalogApiException

getAvailableBasePlanListings

public List<Listing> getAvailableBasePlanListings()
                                           throws CatalogApiException

Specified by:

getAvailableBasePlanListings in interface StaticCatalog

Throws:

CatalogApiException

compliesWithLimits

public boolean compliesWithLimits(String phaseName,
                         String unit,
                         double value)
                           throws CatalogApiException

Specified by:

compliesWithLimits in interface StaticCatalog

Throws:

CatalogApiException