Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2013 Ning, Inc.
   *
   * Ning licenses this file to you under the Apache License, version 2.0
   * (the "License"); you may not use this file except in compliance with the
   * License.  You may obtain a copy of the License at:
   *
   *    http://www.apache.org/licenses/LICENSE-2.0
   *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
  * License for the specific language governing permissions and limitations
  * under the License.
  */
 
 package com.ning.billing.catalog.api;
 
The Catalog information for a specific tenant.
 
 public interface Catalog {

    

Returns:
the catalogName
 
     public String getCatalogName();

    

Parameters:
requestedDate specifies the state of the catalog for that date
Returns:
an array of available Currencys
Throws:
CatalogApiException
 
     public Currency[] getSupportedCurrencies(DateTime requestedDatethrows CatalogApiException;

    

Parameters:
requestedDate specifies the state of the catalog for that date
Returns:
an array of available Products
Throws:
CatalogApiException
 
     public Product[] getProducts(DateTime requestedDatethrows CatalogApiException;

    

Parameters:
requestedDate specifies the state of the catalog for that date
Returns:
an array of available Plans
Throws:
CatalogApiException
 
     public Plan[] getPlans(DateTime requestedDatethrows 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
 
     public Plan findPlan(String nameDateTime requestedDatethrows CatalogApiException;

    

Parameters:
productName the unique name for the Product
billingPeriod the unique name for the BillingPeriod
priceListName the unique name for the PriceList
requestedDate specifies the state of the catalog for that date
Returns:
the Plan
Throws:
CatalogApiException if Plan does not exist
 
     public Plan findPlan(String productNameBillingPeriod billingPeriodString priceListName,
                          DateTime requestedDatethrows 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
 
     public Plan findPlan(String nameDateTime requestedDateDateTime subscriptionStartDatethrows CatalogApiException;

    

Parameters:
productName the unique name for the Product
billingPeriod the unique name for the BillingPeriod
priceListName the unique name for the PriceList
requestedDate specifies the state of the catalog for that date
Returns:
the Plan
Throws:
CatalogApiException if Plan does not exist
 
     public Plan findPlan(String productNameBillingPeriod billingPeriodString priceListName,
                          DateTime requestedDateDateTime subscriptionStartDatethrows 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
 
     public Product findProduct(String nameDateTime requestedDatethrows 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
    public PriceList findPriceList(String nameDateTime requestedDatethrows 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
    public PlanPhase findPhase(String nameDateTime requestedDateDateTime subscriptionStartDatethrows CatalogApiException;
    // TODO : should they be private APIs
                                         PlanSpecifier toDateTime requestedDatethrows CatalogApiException;
                                       PlanSpecifier toDateTime requestedDatethrows CatalogApiException;
    public BillingActionPolicy planCancelPolicy(PlanPhaseSpecifier planPhaseDateTime requestedDatethrows CatalogApiException;
    public PlanAlignmentCreate planCreateAlignment(PlanSpecifier specifierDateTime requestedDatethrows CatalogApiException;
    public BillingAlignment billingAlignment(PlanPhaseSpecifier planPhaseDateTime requestedDatethrows CatalogApiException;
                                                   PlanSpecifier toDateTime requestedDatethrows CatalogApiException;
    public boolean canCreatePlan(PlanSpecifier specifierDateTime requestedDatethrows CatalogApiException;
New to GrepCode? Check out our FAQ X