InvoiceItem.java

Home / api / src / main / java / com / ning / billing / invoice / api / InvoiceItem.java

53 lines | 1.317 kB Blame History Raw Download

/*
 * 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.invoice.api;

import com.ning.billing.catalog.api.Currency;
import com.ning.billing.util.entity.Entity;
import org.joda.time.DateTime;

import java.math.BigDecimal;
import java.util.UUID;

public interface InvoiceItem extends Entity, Comparable<InvoiceItem> {
    UUID getInvoiceId();

    UUID getSubscriptionId();

    DateTime getStartDate();

    DateTime getEndDate();

    String getDescription();

    BigDecimal getAmount();

    BigDecimal getRate();

    Currency getCurrency();

    InvoiceItem asCredit(UUID invoiceId);

    int compareTo(InvoiceItem invoiceItem);

    void subtract(InvoiceItem that);

    boolean duplicates(InvoiceItem that);

    boolean cancels(InvoiceItem that);
}