Bill.java

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package fi.insomnia.bortal.model;

import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Date;
import java.util.List;

import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.JoinColumn;
import javax.persistence.Lob;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.OneToOne;
import javax.persistence.OrderBy;
import javax.persistence.Table;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.persistence.UniqueConstraint;

import org.eclipse.persistence.annotations.OptimisticLocking;
import org.eclipse.persistence.annotations.OptimisticLockingType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import fi.insomnia.bortal.utilities.BillUtils;

/**
 * The system can send bills to the users. When user pays bill a AccountEvent
 * row is created for product whose price is +1 and Bills paidDate is changed to
 * not null.
 */
@Entity
@Table(name = "bills", uniqueConstraints = { @UniqueConstraint(columnNames = { Bill.EVENT_ID_COLUMN, "bill_number" }) })
@OptimisticLocking(type = OptimisticLockingType.CHANGED_COLUMNS)
public class Bill extends GenericEntity {

    /**
     * 
     */
    private static final long serialVersionUID = -6713643278149221869L;
    public static final String EVENT_ID_COLUMN = "event_id";

    @ManyToOne()
    @JoinColumn(name = EVENT_ID_COLUMN, nullable = false)
    private LanEvent event;

    /**
     * When the bill is due to be paid.
     */
    // Can be calculated from SentDate + paymentTime
    // @Column(name = "due_date")
    // @Temporal(TemporalType.TIMESTAMP)
    // private Calendar dueDate;

    /**
     * When the money has appeared on the bank account.
     */
    @Column(name = "paid_date")
    @Temporal(TemporalType.TIMESTAMP)
    private Date paidDate;

    /**
     * The bill number from which the reference number will be generated
     * 
     * @see http://www.fkl.fi/www/page/fk_www_1293
     * 
     */
    @Column(name = "bill_number")
    private Integer billNumber;

    /**
     * Address where the bill should be sent;
     */
    private String addr1;
    private String addr2;
    private String addr3;
    private String addr4;
    private String addr5;

    @Column(nullable = false, name = "sent_time")
    @Temporal(TemporalType.TIMESTAMP)
    private Calendar sentDate = Calendar.getInstance();

    @Column(name = "payment_time", nullable = false)
    private Integer paymentTime = 0;
    @Column(name = "notice_days", nullable = false)
    private String noticetime = "8 vrk";
    @Column(name = "their_reference", nullable = false)
    private String theirReference = "";
    @Column(name = "our_reference", nullable = false)
    private String ourReference = "";
    @Column(name = "delivery_terms", nullable = false)
    private String deliveryTerms = "";
    @Column(name = "delay_intrest", nullable = false)
    private Integer delayIntrest = 11;

    /**
     * Notes for the event organisators about the bill.
     */
    @Lob
    @Column(name = "notes")
    private String notes;

    /**
     * Bill may have multiple items on multiple rows.
     */

    @OrderBy("id")
    // @PrivateOwned
    @OneToMany(mappedBy = "bill", cascade = CascadeType.ALL)
    private List<BillLine> billLines;

    public boolean isPaid()
    {
        return accountEvent != null || paidDate != null;
    }

    /**
     * When the bill is paid this AccountEvent is created and this is a
     * reference to that accountAction. if this bill
     */
    @JoinColumn(name = "account_event_id", referencedColumnName = "id", updatable = false)
    @OneToOne
    private AccountEvent accountEvent;

    /**
     * User who should pay this bill.
     */
    @ManyToOne(optional = false)
    @JoinColumn(updatable = false, name = "eventuser_id")
    private EventUser user;

    private static final Logger logger = LoggerFactory.getLogger(Bill.class);

    public Integer getReferenceNumberBase() {
        if (getEvent() != null && getEvent().getReferenceNumberBase() != null && getBillNumber() != null) {
            return getEvent().getReferenceNumberBase() + getBillNumber();
        }
        return null;
    }

    public Integer getReferenceNumber()
    {
        return BillUtils.createReferenceNumber(getReferenceNumberBase());
    }

    /**
     * Commodity function to calculate the total price of the bill.
     * 
     * @return The total sum of the bill ( unitPrice * units * vat )
     */
    public BigDecimal totalPrice() {
        BigDecimal total = BigDecimal.ZERO;
        for (BillLine line : getBillLines()) {
            total = total.add(line.getLinePrice());
        }
        return total;
    }

    /**
     * Commodity function to calculate the total price of the bill.
     * 
     * @return The total sum of the bill ( unitPrice * units * vat )
     */
    public BigDecimal totalVat() {
        BigDecimal total = BigDecimal.ZERO;
        for (BillLine line : getBillLines()) {
            total = total.add(line.getLineVat());
        }
        return total;
    }

    /**
     * Commodity function to return the vatless price of the bill
     * 
     * @return The total VAT-less sum of the bill ( unitPrice * units )
     */
    public BigDecimal totalPriceVatless() {
        BigDecimal total = BigDecimal.ZERO;
        for (BillLine line : getBillLines()) {
            total = total.add(line.getLinePriceVatless());
        }
        return total;
    }

    public Bill(LanEvent event, EventUser user) {
        this(event);
        this.setUser(user);
        this.setAddr1(user.getUser().getFirstnames() + " " + user.getUser().getLastname());
        this.setAddr2(user.getUser().getAddress());
        this.setAddr3(user.getUser().getZip() + " " + user.getUser().getTown());
    }

    public Bill(LanEvent event) {
        this.event = event;
    }

    public Bill() {
        super();
    }

    public Calendar getDueDate() {

        Calendar dueDate = Calendar.getInstance();
        dueDate.setTime(this.getSentDate().getTime());
        dueDate.add(Calendar.DATE, this.getPaymentTime());
        return dueDate;
    }

    public String getNotes() {
        return notes;
    }

    public void setNotes(String notes) {
        this.notes = notes;
    }

    public List<BillLine> getBillLines() {
        return billLines;
    }

    public void setBillLines(List<BillLine> billLineList) {
        this.billLines = billLineList;
    }

    public AccountEvent getAccountEvent() {
        return accountEvent;
    }

    public void setAccountEvent(AccountEvent accoutEventsId) {
        this.accountEvent = accoutEventsId;
    }

    public EventUser getUser() {
        return user;
    }

    public void setUser(EventUser usersId) {
        this.user = usersId;
    }

    public Integer getBillNumber() {
        return billNumber;
    }

    public String getAddr1() {
        return addr1;
    }

    public void setAddr1(String addr1) {
        this.addr1 = addr1;
    }

    public String getAddr2() {
        return addr2;
    }

    public void setAddr2(String addr2) {
        this.addr2 = addr2;
    }

    public String getAddr3() {
        return addr3;
    }

    public void setAddr3(String addr3) {
        this.addr3 = addr3;
    }

    public String getAddr4() {
        return addr4;
    }

    public void setAddr4(String addr4) {
        this.addr4 = addr4;
    }

    public String getAddr5() {
        return addr5;
    }

    public void setAddr5(String addr5) {
        this.addr5 = addr5;
    }

    public String getNoticetime() {
        return noticetime;
    }

    public void setNoticetime(String noticetime) {
        this.noticetime = noticetime;
    }

    public String getOurReference() {
        return ourReference;
    }

    public void setOurReference(String ourReference) {
        this.ourReference = ourReference;
    }

    public void setTheirReference(String theirReference) {
        this.theirReference = theirReference;
    }

    public String getTheirReference() {
        return theirReference;
    }

    public void setDeliveryTerms(String deliveryTerms) {
        this.deliveryTerms = deliveryTerms;
    }

    public String getDeliveryTerms() {
        return deliveryTerms;
    }

    public void setPaymentTime(Integer paymentTime) {
        this.paymentTime = paymentTime;
    }

    public Integer getPaymentTime() {
        return paymentTime;
    }

    public void setDelayIntrest(Integer delayIntrest) {
        this.delayIntrest = delayIntrest;
    }

    public Integer getDelayIntrest() {
        return delayIntrest;
    }

    public void addProduct(Product product, BigDecimal count) {
        // If bill number > 0 bill has been sent and extra privileges are needed
        // to modify.
        // if (!iscurrent || billnr != null) {
        // permbean.fatalPermission(BillPermission.WRITE_ALL,
        // "User tried to modify bill ", bill,
        // "without sufficient permissions");
        // }
        if (this.billLines == null) {
            billLines = new ArrayList<BillLine>();
        }
        this.getBillLines().add(new BillLine(this, product, count));

        for (Discount disc : product.getActiveDiscounts(count, sentDate)) {

            this.getBillLines().add(new BillLine(this, product, disc, count));

        }
    }

    public void setBillNumber(Integer billNumber) {
        this.billNumber = billNumber;
    }

    public LanEvent getEvent() {
        return event;
    }

    public void setEvent(LanEvent event) {
        this.event = event;
    }

    public Date getPaidDate() {
        return paidDate;
    }

    public void setPaidDate(Date paidDate) {
        this.paidDate = paidDate;
    }

    public Date getSentDateTime()
    {
        Date ret = null;
        if (sentDate != null)
        {
            ret = sentDate.getTime();
        }
        return ret;
    }

    public void setSentDateTime(Date date)
    {
        if (date == null)
        {
            sentDate = null;
        } else {
            if (sentDate == null)
            {
                sentDate = Calendar.getInstance();
            }
            sentDate.setTime(date);
        }
    }

    public Calendar getSentDate() {
        return sentDate;
    }

    public void setSentDate(Calendar sentDate) {
        this.sentDate = sentDate;
    }

}