com.billing.ng.entities.BillingCycle.java Source code

Introduction

Here is the source code for com.billing.ng.entities.BillingCycle.java

Source

/*
 BillingNG, a next-generation billing solution
 Copyright (C) 2010 Brian Cowdery
    
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as
 published by the Free Software Foundation, either version 3 of the
 License, or (at your option) any later version.
    
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Affero General Public License for more details.
 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see http://www.gnu.org/licenses/agpl-3.0.html
 */

package com.billing.ng.entities;

import org.joda.time.DateMidnight;
import org.joda.time.Period;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.ManyToOne;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;
import java.util.Date;

/**
 * The billing cycle start and end date of a customer that defines when a customer starts
 * and stops receiving invoices.
 *
 * @author Brian Cowdery
 * @since 26-Oct-2010
 */
@Entity
@XmlRootElement
public class BillingCycle extends BaseEntity {

    public static final int LAST_DAY_OF_MONTH = 31;

    @GeneratedValue
    @Id
    private Long id;

    @Column
    @Temporal(TemporalType.DATE)
    private Date start = new Date(); // default start date to today
    @Column
    @Temporal(TemporalType.DATE)
    private Date end;
    @Column
    @Min(1)
    @Max(31)
    private Integer cycleStartDay;
    @ManyToOne
    private BillingPeriod billingPeriod;

    public BillingCycle() {
    }

    public BillingCycle(BillingPeriod.Type type, Integer interval) {
        this.billingPeriod = new BillingPeriod(type, interval);
    }

    @XmlAttribute
    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    @XmlAttribute
    public Date getStart() {
        return start;
    }

    public void setStart(Date start) {
        this.start = start;
    }

    @XmlAttribute
    public Date getEnd() {
        return end;
    }

    public void setEnd(Date end) {
        this.end = end;
    }

    /**
     * Day of month that this customers cycle starts.
     *
     * @return cycle start day of month
     */
    @XmlAttribute
    public Integer getCycleStartDay() {
        return cycleStartDay;
    }

    /**
     * Sets the day of month that this customer cycle starts. Use
     * <code>BillingCycle.LAST_DAY_OF_MONTH</code> for the last day of the month.
     *
     * @param cycleStartDay cycle start day of month
     */
    public void setCycleStartDay(Integer cycleStartDay) {
        this.cycleStartDay = cycleStartDay;
    }

    @XmlElement
    public BillingPeriod getBillingPeriod() {
        return billingPeriod;
    }

    public void setBillingPeriod(BillingPeriod billingPeriod) {
        this.billingPeriod = billingPeriod;
    }

    /**
     * Returns true if today's date is between the start and end date for
     * this billing cycle.
     *
     * @return true if cycle is active for today's date, false if not
     */
    @XmlTransient
    public boolean isActive() {
        return isActive(new DateMidnight());
    }

    /**
     * Returns true if the given date is between the start and end date
     * for this billing cycle.
     *
     * @param date active date
     * @return true if cycle is active for the given date, false if not
     */
    @SuppressWarnings({ "RedundantIfStatement" }) // verbose if statements for clarity
    public boolean isActive(DateMidnight date) {
        if (getStart() != null && new DateMidnight(getStart()).isAfter(date))
            return false;

        if (getEnd() != null && new DateMidnight(getEnd()).isBefore(date))
            return false;

        return true;
    }

    /**
     * The initial starting instant of the entire billing cycle. The start instant is
     * the first instance of the cycle start day after (or equal to) the cycle start date.
     *
     * @return starting instant of this billing cycle
     */
    public DateMidnight getStartInstant() {
        DateMidnight start = new DateMidnight(getStart());
        Period period = getBillingPeriod().getPeriodOfTime();

        // first possible start date for a period
        DateMidnight calculated = getCycleStartDay() != LAST_DAY_OF_MONTH
                ? start.dayOfMonth().setCopy(getCycleStartDay())
                : start.dayOfMonth().withMaximumValue();

        // increment by billing period interval until a valid start date is found
        while (calculated.isBefore(start)) {
            calculated = calculated.plus(period);
        }
        return calculated;
    }

    /**
     * The end instant of the entire billing cycle. The end instant is the last day
     * of the billing cycle, effectively {@link #getEnd()}.
     *
     * If billing cycle end is null, this method will return the start instant
     * with the year {@link BillingPeriod} incremented to it's maximum value.
     *
     * @return ending instant of this billing cycle
     */
    public DateMidnight getEndInstant() {
        return getEnd() == null ? getStartInstant().year().withMaximumValue() : new DateMidnight(getEnd());
    }

    /**
     * Calculates the current billing cycle for today's date.
     *
     * @return current billing cycle as of today
     */
    @XmlTransient
    public CurrentBillingCycle getCurrentBillingCycle() {
        return new CurrentBillingCycle(getBillingPeriod(), getStartInstant());
    }

    /**
     * Calculates the current billing cycle for the given date.
     *
     * @param today date to calculate billing cycle for
     * @return current billing cycle for the given date
     */
    public CurrentBillingCycle getCurrentBillingCycle(DateMidnight today) {
        return new CurrentBillingCycle(getBillingPeriod(), getStartInstant(), today);
    }
}