Package org.killbill.billing.catalog.api

Interface StaticCatalog

All Known Subinterfaces:

MutableStaticCatalog

public interface StaticCatalog

The interface StaticCatalog gives the view of that Catalog at a given time. This represents a specific version of the Catalog

Method Summary

Modifier and Type	Method	Description
Plan	createOrFindPlan(PlanSpecifier spec, PlanPhasePriceOverridesWithCallContext overrides)
PlanPhase	findPhase(String name)
Plan	findPlan(String name)
PriceList	findPriceList(String name)
Product	findProduct(String name)
List<Listing>	getAvailableAddOnListings(String baseProductName, String priceListName)
List<Listing>	getAvailableBasePlanListings()
String	getCatalogName()
Date	getEffectiveDate()
PlanRules	getPlanRules()
Collection<Plan>	getPlans()
PriceListSet	getPriceLists()
Collection<Product>	getProducts()
Currency[]	getSupportedCurrencies()
Unit[]	getUnits()

Method Detail

getCatalogName

String getCatalogName()

Returns:

the Catalog name

getEffectiveDate

Date getEffectiveDate()

Returns:

the date at which this version of Catalog becomes effective

getSupportedCurrencies

Currency[] getSupportedCurrencies()

Returns:

an array of supported Currency

getProducts

Collection<Product> getProducts()

Returns:

an array of supported Product

getUnits

Unit[] getUnits()

Returns:

an array of supported Unit

getPlans

Collection<Plan> getPlans()

Returns:

an array of supported Plan

getPlanRules

PlanRules getPlanRules()

Returns:

All the catalog rules

createOrFindPlan

Plan createOrFindPlan(PlanSpecifier spec,
                      PlanPhasePriceOverridesWithCallContext overrides)
               throws CatalogApiException

Parameters:

spec - the specification for the Plan to be used

overrides - the price override for each phase and for a specific currency

Returns:

the Plan

Throws:

CatalogApiException - if not such Plan can be found

findPlan

Plan findPlan(String name)
       throws CatalogApiException

Parameters:

name - the name of the

Returns:

the Plan

Throws:

CatalogApiException - if not such Plan can be found

findProduct

Product findProduct(String name)
             throws CatalogApiException

Parameters:

name - the name of the Product

Returns:

the Product

Throws:

CatalogApiException - if no such Product exists

findPhase

PlanPhase findPhase(String name)
             throws CatalogApiException

Parameters:

name - the name of the PlanPhase

Returns:

the PlanPhase

Throws:

CatalogApiException - if no such PlanPhase exists

getPriceLists

PriceListSet getPriceLists()
                    throws CatalogApiException

Returns:

the set of PriceList

Throws:

CatalogApiException

findPriceList

PriceList findPriceList(String name)
                 throws CatalogApiException

Parameters:

name - the name of the PriceList

Returns:

the PriceList

Throws:

CatalogApiException

getAvailableBasePlanListings

List<Listing> getAvailableBasePlanListings()

Returns:

All existing BASE Plan

getAvailableAddOnListings

List<Listing> getAvailableAddOnListings(String baseProductName,
                                        String priceListName)

Parameters:

baseProductName - the base Plan

priceListName - the base PriceList

Returns:

All existing ADD_ON Plan