Plan.java

/*
 * Copyright 2010-2011 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;

import java.util.Date;
import java.util.Iterator;

public interface Plan {

	public abstract PlanPhase[] getInitialPhases();

	public abstract Product getProduct();

	public abstract String getName();

	public abstract boolean isRetired();

	public abstract Iterator<PlanPhase> getInitialPhaseIterator();

	public abstract PlanPhase getFinalPhase();

	public abstract BillingPeriod getBillingPeriod();

	public abstract int getPlansAllowedInBundle();

	public abstract PlanPhase[] getAllPhases();

	public abstract Date getEffectiveDateForExistingSubscriptons();

	public abstract PlanPhase findPhase(String name) throws CatalogApiException;
}