org.killbill.billing.catalog.api

Interface CatalogUserApi

All Superinterfaces:

KillbillApi

public interface CatalogUserApi
extends KillbillApi

The interface CatalogUserApi to retrieve catalog information

Method Summary

Methods

Modifier and Type	Method and Description
Catalog	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)

Method Detail

getCatalog

Catalog 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