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.Calendar;
import java.util.List;

import javax.persistence.Column;
import javax.persistence.EmbeddedId;
import javax.persistence.Entity;
import javax.persistence.JoinColumn;
import javax.persistence.JoinColumns;
import javax.persistence.Lob;
import javax.persistence.ManyToOne;
import javax.persistence.NamedQueries;
import javax.persistence.NamedQuery;
import javax.persistence.OneToMany;
import javax.persistence.OneToOne;
import javax.persistence.Table;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.persistence.Version;

/**
 * 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")
@NamedQueries( {
        @NamedQuery(name = "Bill.findAll", query = "SELECT b FROM Bill b"),

        @NamedQuery(name = "Bill.findByDueDate", query = "SELECT b FROM Bill b WHERE b.dueDate = :dueDate"),
        @NamedQuery(name = "Bill.findByPaidDate", query = "SELECT b FROM Bill b WHERE b.paidDate = :paidDate"),
        @NamedQuery(name = "Bill.findByReferenceNumber", query = "SELECT b FROM Bill b WHERE b.referenceNumber = :referenceNumber"),
        @NamedQuery(name = "Bill.findByNotes", query = "SELECT b FROM Bill b WHERE b.notes = :notes") })
public class Bill implements EventChildInterface {

    private static final long serialVersionUID = 1L;

    @EmbeddedId
    private EventPk id;

    /**
     * When the bill is due to be paid.
     */
    @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 Calendar paidDate;

    /**
     * Reference number of the bill.
     * 
     * @See http://www.fkl.fi/www/page/fk_www_1293
     */
    @Column(name = "reference_number")
    private String referenceNumber;

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

    /**
     * Bill may have multiple items on multiple rows.
     */
    @OneToMany(mappedBy = "bill")
    private List<BillLine> billLines;

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

    /**
     * User who should pay this bill.
     */
    @JoinColumn(name = "user_id", referencedColumnName = "user_id", nullable = false)
    @ManyToOne(optional = false)
    private User user;

    @ManyToOne
    @JoinColumn(name = "event_id", referencedColumnName = "event_id", updatable = false, insertable = false)
    private Event event;

    /**
     * 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 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;
    }

    @Override
    public EventPk getId() {
        return id;
    }

    @Override
    public void setId(EventPk id) {
        this.id = id;
    }

    @Version
    @Column(nullable = false)
    private int jpaVersionField = 0;

    public Bill() {
    }

    public Bill(Event event) {
        this.id = new EventPk(event);
    }

    public Calendar getDueDate() {
        return dueDate;
    }

    public void setDueDate(Calendar dueDate) {
        this.dueDate = dueDate;
    }

    public Calendar getPaidDate() {
        return paidDate;
    }

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

    public String getReferenceNumber() {
        return referenceNumber;
    }

    public void setReferenceNumber(String referenceNumber) {
        this.referenceNumber = referenceNumber;
    }

    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 User getUser() {
        return user;
    }

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

    @Override
    public int hashCode() {
        int hash = 0;
        hash += (id != null ? id.hashCode() : 0);
        return hash;
    }

    @Override
    public boolean equals(Object object) {
        // TODO: Warning - this method won't work in the case the id fields are
        // not set
        if (!(object instanceof Bill)) {
            return false;
        }
        Bill other = (Bill) object;
        if ((this.id == null && other.id != null)
                || (this.id != null && !this.id.equals(other.id))) {
            return false;
        }
        return true;
    }

    @Override
    public String toString() {
        return "fi.insomnia.bortal.model.Bill[id=" + id + "]";
    }

    @Override
    public void setJpaVersionField(int jpaVersionField) {
        this.jpaVersionField = jpaVersionField;
    }

    @Override
    public int getJpaVersionField() {
        return jpaVersionField;
    }

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

    public Event getEvent() {
        return event;
    }
}