org.killbill.billing.catalog.api

Interface StaticCatalog

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

Methods

Modifier and Type	Method and Description
BillingAlignment	billingAlignment(PlanPhaseSpecifier planPhase)
boolean	canCreatePlan(PlanSpecifier specifier)
boolean	compliesWithLimits(String phaseName, String unit, double value)
PlanPhase	findCurrentPhase(String name)
Plan	findCurrentPlan(String name)
Plan	findCurrentPlan(String productName, BillingPeriod billingPeriod, String priceList)
PriceList	findCurrentPricelist(String name)
Product	findCurrentProduct(String name)
List<Listing>	getAvailableAddonListings(String baseProductName)
List<Listing>	getAvailableBasePlanListings()
String	getCatalogName()
Plan[]	getCurrentPlans()
Product[]	getCurrentProducts()
Currency[]	getCurrentSupportedCurrencies()
Unit[]	getCurrentUnits()
Date	getEffectiveDate()
BillingMode	getRecurringBillingMode()
BillingActionPolicy	planCancelPolicy(PlanPhaseSpecifier planPhase)
PlanChangeResult	planChange(PlanPhaseSpecifier from, PlanSpecifier to)
PlanAlignmentChange	planChangeAlignment(PlanPhaseSpecifier from, PlanSpecifier to)
BillingActionPolicy	planChangePolicy(PlanPhaseSpecifier from, PlanSpecifier to)
PlanAlignmentCreate	planCreateAlignment(PlanSpecifier specifier)

Method Detail

getCatalogName

String getCatalogName()

Returns:

the Catalog name

getRecurringBillingMode

BillingMode getRecurringBillingMode()

Returns:

the recurring billing mode for this catalog

getEffectiveDate

Date getEffectiveDate()
                      throws CatalogApiException

Returns:

the date at which this version of Catalog becomes effective

Throws:

CatalogApiException

getCurrentSupportedCurrencies

Currency[] getCurrentSupportedCurrencies()
                                         throws CatalogApiException

Returns:

an array of supported Currency

Throws:

CatalogApiException

getCurrentProducts

Product[] getCurrentProducts()
                             throws CatalogApiException

Returns:

an array of supported Product

Throws:

CatalogApiException

getCurrentUnits

Unit[] getCurrentUnits()
                       throws CatalogApiException

Returns:

an array of supported Unit

Throws:

CatalogApiException

getCurrentPlans

Plan[] getCurrentPlans()
                       throws CatalogApiException

Returns:

an array of supported Plan

Throws:

CatalogApiException

findCurrentPlan

Plan findCurrentPlan(String productName,
                   BillingPeriod billingPeriod,
                   String priceList)
                     throws CatalogApiException

Parameters:

productName - the Product name

billingPeriod - the billingPeriod

priceList - the name of the PriceList

Returns:

the Plan

Throws:

CatalogApiException - if not such Plan can be found

findCurrentPlan

Plan findCurrentPlan(String name)
                     throws CatalogApiException

Parameters:

name - the name of the

Returns:

the Plan

Throws:

CatalogApiException - if not such Plan can be found

findCurrentProduct

Product findCurrentProduct(String name)
                           throws CatalogApiException

Parameters:

name - the name of the Product

Returns:

the Product

Throws:

CatalogApiException - if no such Product exists

findCurrentPhase

PlanPhase findCurrentPhase(String name)
                           throws CatalogApiException

Parameters:

name - the name of the PlanPhase

Returns:

the PlanPhase

Throws:

CatalogApiException - if no such PlanPhase exists

findCurrentPricelist

PriceList findCurrentPricelist(String name)
                               throws CatalogApiException

Parameters:

name - the name of the PriceList

Returns:

the PriceList

Throws:

CatalogApiException - if no such PriceList exists

planChangePolicy

BillingActionPolicy planChangePolicy(PlanPhaseSpecifier from,
                                   PlanSpecifier to)
                                     throws CatalogApiException

Throws:

CatalogApiException

planChange

PlanChangeResult planChange(PlanPhaseSpecifier from,
                          PlanSpecifier to)
                            throws CatalogApiException

Throws:

CatalogApiException

planCancelPolicy

BillingActionPolicy planCancelPolicy(PlanPhaseSpecifier planPhase)
                                     throws CatalogApiException

Throws:

CatalogApiException

planCreateAlignment

PlanAlignmentCreate planCreateAlignment(PlanSpecifier specifier)
                                        throws CatalogApiException

Throws:

CatalogApiException

billingAlignment

BillingAlignment billingAlignment(PlanPhaseSpecifier planPhase)
                                  throws CatalogApiException

Throws:

CatalogApiException

planChangeAlignment

PlanAlignmentChange planChangeAlignment(PlanPhaseSpecifier from,
                                      PlanSpecifier to)
                                        throws CatalogApiException

Throws:

CatalogApiException

canCreatePlan

boolean canCreatePlan(PlanSpecifier specifier)
                      throws CatalogApiException

Throws:

CatalogApiException

getAvailableBasePlanListings

List<Listing> getAvailableBasePlanListings()
                                           throws CatalogApiException

Throws:

CatalogApiException

getAvailableAddonListings

List<Listing> getAvailableAddonListings(String baseProductName)
                                        throws CatalogApiException

Throws:

CatalogApiException

compliesWithLimits

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

Throws:

CatalogApiException