SubscriptionTransition.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.api.user;

import com.ning.billing.catalog.api.Plan;
import com.ning.billing.catalog.api.PlanPhase;
import com.ning.billing.entitlement.api.user.Subscription.SubscriptionState;
import com.ning.billing.util.eventbus.EventBusNotification;
import org.joda.time.DateTime;

import java.util.UUID;

public interface SubscriptionTransition extends EventBusNotification {

    public enum SubscriptionTransitionType {
        MIGRATE_ENTITLEMENT,
        CREATE,
        CHANGE,
        PAUSE,
        RESUME,
        CANCEL,
        UNCANCEL,
        PHASE
    }

    UUID getId();

    SubscriptionTransitionType getTransitionType();

    UUID getBundleId();

    UUID getSubscriptionId();

    DateTime getRequestedTransitionTime();

    DateTime getEffectiveTransitionTime();

    SubscriptionState getPreviousState();

    Plan getPreviousPlan();

    String getPreviousPriceList();

    PlanPhase getPreviousPhase();

    Plan getNextPlan();

    PlanPhase getNextPhase();

    SubscriptionState getNextState();

    String getNextPriceList();
}