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 and Description
BillingAlignment	billingAlignment(PlanPhaseSpecifier planPhase)
boolean	canCreatePlan(PlanSpecifier specifier)
boolean	compliesWithLimits(java.lang.String phaseName, java.lang.String unit, double value)
Plan	createOrFindCurrentPlan(PlanSpecifier spec, PlanPhasePriceOverridesWithCallContext overrides)
PlanPhase	findCurrentPhase(java.lang.String name)
Plan	findCurrentPlan(java.lang.String name)
PriceList	findCurrentPricelist(java.lang.String name)
Product	findCurrentProduct(java.lang.String name)
java.util.List<Listing>	getAvailableAddOnListings(java.lang.String baseProductName, java.lang.String priceListName)
java.util.List<Listing>	getAvailableBasePlanListings()
java.lang.String	getCatalogName()
java.util.Collection<Plan>	getCurrentPlans()
java.util.Collection<Product>	getCurrentProducts()
Currency[]	getCurrentSupportedCurrencies()
Unit[]	getCurrentUnits()
java.util.Date	getEffectiveDate()
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

java.lang.String getCatalogName()

Returns:

the Catalog name

getEffectiveDate

java.util.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

java.util.Collection<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

java.util.Collection<Plan> getCurrentPlans()
                                    throws CatalogApiException

Returns:

an array of supported Plan

Throws:

CatalogApiException

createOrFindCurrentPlan

Plan createOrFindCurrentPlan(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

findCurrentPlan

Plan findCurrentPlan(java.lang.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(java.lang.String name)
                    throws CatalogApiException

Parameters:

name - the name of the Product

Returns:

the Product

Throws:

CatalogApiException - if no such Product exists

findCurrentPhase

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

Parameters:

name - the name of the PlanPhase

Returns:

the PlanPhase

Throws:

CatalogApiException - if no such PlanPhase exists

findCurrentPricelist

PriceList findCurrentPricelist(java.lang.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

java.util.List<Listing> getAvailableBasePlanListings()
                                              throws CatalogApiException

Throws:

CatalogApiException

getAvailableAddOnListings

java.util.List<Listing> getAvailableAddOnListings(java.lang.String baseProductName,
                                                  java.lang.String priceListName)
                                           throws CatalogApiException

Throws:

CatalogApiException

compliesWithLimits

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

Throws:

CatalogApiException