org.killbill.billing.catalog.api

Interface Catalog

All Known Subinterfaces:

MutableCatalog, VersionedCatalog<CatalogType>

public interface Catalog

The Catalog information for a specific tenant.

Method Summary

Modifier and Type	Method and Description
BillingAlignment	billingAlignment(PlanPhaseSpecifier planPhase, org.joda.time.DateTime requestedDate, org.joda.time.DateTime subscriptionStartDate)
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	findPhase(java.lang.String name, org.joda.time.DateTime requestedDate, org.joda.time.DateTime subscriptionStartDate)
Plan	findPlan(java.lang.String name, org.joda.time.DateTime requestedDate)
Plan	findPlan(java.lang.String name, org.joda.time.DateTime requestedDate, org.joda.time.DateTime subscriptionStartDate)
PriceList	findPriceListForPlan(java.lang.String planName, org.joda.time.DateTime requestedDate, org.joda.time.DateTime subscriptionStartDate)
Product	findProduct(java.lang.String name, org.joda.time.DateTime requestedDate)
java.lang.String	getCatalogName()
java.util.Collection<Plan>	getPlans(org.joda.time.DateTime requestedDate)
PriceListSet	getPriceLists(org.joda.time.DateTime requestedDate)
java.util.Collection<Product>	getProducts(org.joda.time.DateTime requestedDate)
java.util.Date	getStandaloneCatalogEffectiveDate(org.joda.time.DateTime requestedDate)
Currency[]	getSupportedCurrencies(org.joda.time.DateTime requestedDate)
Unit[]	getUnits(org.joda.time.DateTime requestedDate)
BillingActionPolicy	planCancelPolicy(PlanPhaseSpecifier planPhase, org.joda.time.DateTime requestedDate, org.joda.time.DateTime subscriptionStartDate)
PlanChangeResult	planChange(PlanPhaseSpecifier from, PlanSpecifier to, org.joda.time.DateTime requestedDate, org.joda.time.DateTime subscriptionStartDate)
PlanAlignmentCreate	planCreateAlignment(PlanSpecifier specifier, org.joda.time.DateTime requestedDate, org.joda.time.DateTime subscriptionStartDate)

Method Detail

getCatalogName

java.lang.String getCatalogName()

Returns:

the catalogName

getStandaloneCatalogEffectiveDate

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

Parameters:

requestedDate - the requestedDate

Returns:

the effective for the StandaloneCatalog matching that requestedDate

Throws:

CatalogApiException - if no catalog can be found for that date

getSupportedCurrencies

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

Parameters:

requestedDate - specifies the state of the catalog for that date

Returns:

an array of available Currencys

Throws:

CatalogApiException - if no catalog can be found for that date

getUnits

Unit[] getUnits(org.joda.time.DateTime requestedDate)
         throws CatalogApiException

Parameters:

requestedDate - specifies the state of the catalog for that date

Returns:

an array of available Units

Throws:

CatalogApiException - if no catalog can be found for that date

getProducts

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

Parameters:

requestedDate - specifies the state of the catalog for that date

Returns:

an array of available Products

Throws:

CatalogApiException - if no catalog can be found for that date

getPlans

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

Parameters:

requestedDate - specifies the state of the catalog for that date

Returns:

an array of available Plans

Throws:

CatalogApiException - if no catalog can be found for that date

getPriceLists

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

Parameters:

requestedDate - specifies the state of the catalog for that date

Returns:

the PriceListSet for that requestedDate

Throws:

CatalogApiException - if no catalog can be found for that date

findPlan

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

Parameters:

name - the unique name of the plan

requestedDate - specifies the state of the catalog for that date

Returns:

the Plan

Throws:

CatalogApiException - if no catalog can be found for that date or if the Plan does not exist

createOrFindPlan

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

Parameters:

spec - the specification for the Plan to be used

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

requestedDate - specifies the state of the catalog for that date

Returns:

the Plan

Throws:

CatalogApiException - if no catalog can be found for that date or if the Plan cannot be found nor created

findPlan

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

Parameters:

name - the unique name of the plan

requestedDate - specifies the state of the catalog for that date

subscriptionStartDate - the startDate of the subscription

Returns:

the Plan

Throws:

CatalogApiException - if no catalog can be found for that date or if the Plan does not exist

createOrFindPlan

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

Parameters:

spec - the specification for the Plan to be used

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

requestedDate - specifies the state of the catalog for that date

Returns:

the Plan

Throws:

CatalogApiException - if no catalog can be found for that date or if the Plan cannot be found nor created

findProduct

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

Parameters:

name - the unique name for the Product

requestedDate - specifies the state of the catalog for that date

Returns:

the Product

Throws:

CatalogApiException - if no catalog can be found for that date or if the Product does not exist

findPriceListForPlan

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

Parameters:

planName - the unique name of the plan

requestedDate - specifies the state of the catalog for that date

Returns:

the PriceList

Throws:

CatalogApiException - if no catalog can be found for that date or if the PriceList does not exist

findPhase

PlanPhase findPhase(java.lang.String name,
                    org.joda.time.DateTime requestedDate,
                    org.joda.time.DateTime subscriptionStartDate)
             throws CatalogApiException

Parameters:

name - the unique name for the PlanPhase

requestedDate - specifies the state of the catalog for that date

subscriptionStartDate - the startDate of the subscription

Returns:

the PlanPhase

Throws:

CatalogApiException - if the PlanPhase does not exist

planChange

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

Throws:

CatalogApiException

planCancelPolicy

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

Throws:

CatalogApiException

planCreateAlignment

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

Throws:

CatalogApiException

billingAlignment

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

Throws:

CatalogApiException