Package org.killbill.billing.catalog.api

Interface CatalogUserApi

All Superinterfaces:

KillbillApi

public interface CatalogUserApi
extends KillbillApi

The interface CatalogUserApi to retrieve catalog information

Method Summary

Modifier and Type	Method	Description
void	addSimplePlan(SimplePlanDescriptor planDescriptor, org.joda.time.DateTime requestedDate, CallContext context)	Allows to add plan definition in existing per-tenant catalog.
void	createDefaultEmptyCatalog(org.joda.time.DateTime effectiveDate, CallContext callContext)	Creates a per-tenant default template catalog
void	deleteCatalog(CallContext callContext)	Delete a per-tenant catalog (should be used with caution)
VersionedCatalog	getCatalog(String catalogName, TenantContext context)	Retrieves the multi versioned catalog.
StaticCatalog	getCurrentCatalog(String catalogName, TenantContext context)	Retrieves the current catalog
void	uploadCatalog(String catalogXML, CallContext context)
CatalogValidation	validateCatalog(String catalogXML, CallContext context)	Validates a catalog

Method Detail

getCatalog

VersionedCatalog getCatalog(String catalogName,
                            TenantContext context)
                     throws CatalogApiException

Retrieves the multi versioned catalog.

Parameters:

catalogName - the name of the catalog

context - the user context that specifies the tenant information

Returns:

the Catalog

Throws:

CatalogApiException

getCurrentCatalog

StaticCatalog getCurrentCatalog(String catalogName,
                                TenantContext context)
                         throws CatalogApiException

Retrieves the current catalog

Parameters:

catalogName - the name of the catalog

context - the user context that specifies the tenant information

Returns:

the Catalog

Throws:

CatalogApiException

uploadCatalog

void uploadCatalog(String catalogXML,
                   CallContext context)
            throws CatalogApiException

Parameters:

catalogXML - the catalog XML

context - the user context

Throws:

CatalogApiException

validateCatalog

CatalogValidation validateCatalog(String catalogXML,
                                  CallContext context)

Validates a catalog

Parameters:

catalogXML - the catalog XML

context - the user context

Returns:

the CatalogValidation

createDefaultEmptyCatalog

void createDefaultEmptyCatalog(org.joda.time.DateTime effectiveDate,
                               CallContext callContext)
                        throws CatalogApiException

Creates a per-tenant default template catalog

Parameters:

effectiveDate - the effective date for this catalog

callContext - the user context

Throws:

CatalogApiException

addSimplePlan

void addSimplePlan(SimplePlanDescriptor planDescriptor,
                   org.joda.time.DateTime requestedDate,
                   CallContext context)
            throws CatalogApiException

Allows to add plan definition in existing per-tenant catalog. The simplicity of the api limits the types of plans that can be added (recurring evergreen plans defined for one currency with or without a trial)

Parameters:

planDescriptor -

requestedDate -

context -

Throws:

CatalogApiException

deleteCatalog

void deleteCatalog(CallContext callContext)
            throws CatalogApiException

Delete a per-tenant catalog (should be used with caution)

Parameters:

callContext - the user context

Throws:

CatalogApiException