org.killbill.billing.catalog.api

Interface Catalog

public interface Catalog

The Catalog information for a specific tenant.

Method Summary

Methods

Modifier and Type	Method and Description
BillingAlignment	billingAlignment(PlanPhaseSpecifier planPhase, org.joda.time.DateTime requestedDate)
boolean	canCreatePlan(PlanSpecifier specifier, org.joda.time.DateTime requestedDate)
Plan	createOrFindPlan(String productName, BillingPeriod billingPeriod, String priceListName, PlanPhasePriceOverridesWithCallContext overrides, org.joda.time.DateTime requestedDate)
Plan	createOrFindPlan(String productName, BillingPeriod billingPeriod, String priceListName, PlanPhasePriceOverridesWithCallContext overrides, org.joda.time.DateTime requestedDate, org.joda.time.DateTime subscriptionStartDate)
PlanPhase	findPhase(String name, 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)
Product	findProduct(String name, org.joda.time.DateTime requestedDate)
String	getCatalogName()
Plan[]	getPlans(org.joda.time.DateTime requestedDate)
Product[]	getProducts(org.joda.time.DateTime requestedDate)
Currency[]	getSupportedCurrencies(org.joda.time.DateTime requestedDate)
BillingActionPolicy	planCancelPolicy(PlanPhaseSpecifier planPhase, org.joda.time.DateTime requestedDate)
PlanChangeResult	planChange(PlanPhaseSpecifier from, PlanSpecifier to, org.joda.time.DateTime requestedDate)
PlanAlignmentChange	planChangeAlignment(PlanPhaseSpecifier from, PlanSpecifier to, org.joda.time.DateTime requestedDate)
BillingActionPolicy	planChangePolicy(PlanPhaseSpecifier from, PlanSpecifier to, org.joda.time.DateTime requestedDate)
PlanAlignmentCreate	planCreateAlignment(PlanSpecifier specifier, org.joda.time.DateTime requestedDate)

Method Detail

getCatalogName

String getCatalogName()

Returns:

the catalogName

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

getProducts

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

getPlans

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

findPlan

Plan findPlan(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 Plan does not exist

createOrFindPlan

Plan createOrFindPlan(String productName,
                    BillingPeriod billingPeriod,
                    String priceListName,
                    PlanPhasePriceOverridesWithCallContext overrides,
                    org.joda.time.DateTime requestedDate)
                      throws CatalogApiException

Parameters:

productName - the unique name for the Product

billingPeriod - the unique name for the BillingPeriod

priceListName - the unique name for the PriceList

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 Plan does not exist

findPlan

Plan findPlan(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 Plan does not exist

createOrFindPlan

Plan createOrFindPlan(String productName,
                    BillingPeriod billingPeriod,
                    String priceListName,
                    PlanPhasePriceOverridesWithCallContext overrides,
                    org.joda.time.DateTime requestedDate,
                    org.joda.time.DateTime subscriptionStartDate)
                      throws CatalogApiException

Parameters:

productName - the unique name for the Product

billingPeriod - the unique name for the BillingPeriod

priceListName - the unique name for the PriceList

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 Plan does not exist

findProduct

Product findProduct(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 Product does not exist

findPriceList

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

Parameters:

name - the unique name for the PlanPhase

requestedDate - specifies the state of the catalog for that date

Returns:

the PlanPhase

Throws:

CatalogApiException - if the PlanPhase does not exist

findPhase

PlanPhase findPhase(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

planChangePolicy

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

Throws:

CatalogApiException

planChange

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

Throws:

CatalogApiException

planCancelPolicy

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

Throws:

CatalogApiException

planCreateAlignment

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

Throws:

CatalogApiException

billingAlignment

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

Throws:

CatalogApiException

planChangeAlignment

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

Throws:

CatalogApiException

canCreatePlan

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

Throws:

CatalogApiException