IPlanAligner.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.entitlement.alignment;

import org.joda.time.DateTime;

import com.ning.billing.catalog.api.IPlan;
import com.ning.billing.catalog.api.IPlanPhase;
import com.ning.billing.entitlement.api.user.Subscription;

public interface IPlanAligner {


    public final static class TimedPhase {

        private final IPlanPhase phase;
        private final DateTime startPhase;

        public TimedPhase(IPlanPhase phase, DateTime startPhase) {
            super();
            this.phase = phase;
            this.startPhase = startPhase;
        }

        public IPlanPhase getPhase() {
            return phase;
        }

        public DateTime getStartPhase() {
            return startPhase;
        }
    }

    public TimedPhase getCurrentTimedPhaseOnCreate(Subscription subscription, IPlan plan,  String priceList, DateTime effectiveDate);

    public TimedPhase getNextTimedPhaseOnCreate(Subscription subscription, IPlan plan,  String priceList, DateTime effectiveDate);

    public TimedPhase getCurrentTimedPhaseOnChange(Subscription subscription, IPlan plan,  String priceList, DateTime effectiveDate);

    public TimedPhase getNextTimedPhaseOnChange(Subscription subscription, IPlan plan,  String priceList, DateTime effectiveDate);

    public TimedPhase getNextTimedPhase(Subscription subscription, IPlan plan, DateTime effectiveDate, DateTime planStartDate);


}