/*
 * Copyright (c) 2005-2011 Grameen Foundation USA
 * All rights reserved.
 *
 * Licensed 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.
 *
 * See also http://www.apache.org/licenses/LICENSE-2.0.html for an
 * explanation of the license and how it is applied.
 */

package org.mifos.accounts.util.helpers;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;

import org.mifos.accounts.business.AccountPaymentEntity;
import org.mifos.application.admin.servicefacade.InvalidDateException;
import org.mifos.customers.business.CustomerBO;
import org.mifos.customers.personnel.business.PersonnelBO;
import org.mifos.framework.util.helpers.Money;

/*
 * Used to hold information entered about a payment made.
 * Currently this is populated from data entered on a web page.
 */
public class PaymentData {

    private final Money totalAmount;
    private CustomerBO customer;
    private final PersonnelBO personnel;
    private Date transactionDate;

    private String receiptNum;
    private Date receiptDate;
    private final Short paymentTypeId;
    private String comment;
    private Money overpaymentAmount;
    private boolean adjustment;

    private boolean allowOverpayment;

    private AccountPaymentEntity otherTransferPayment;
    /*
     * Holds information including the installment this payment is to be applied
     * towards and any installments in arrears.
     */
    private List<AccountPaymentData> accountPayments;
    private AccountPaymentEntity parentPayment;

    public static PaymentData createPaymentData(Money totalAmount, PersonnelBO personnel, Short paymentTypeId,
            Date transactionDate) {
        return new PaymentData(totalAmount, personnel, paymentTypeId, transactionDate);
    }

    /**
     * @deprecated
     */
    @Deprecated
    public static PaymentData createPaymentData(PaymentDataTemplate template) throws InvalidDateException {
        return new PaymentData(template.getTotalAmount(), template.getPersonnel(), template.getPaymentTypeId(),
                template.getTransactionDate());
    }

    public PaymentData(Money totalAmount, PersonnelBO personnel, Short paymentTypeId, Date transactionDate) {
        accountPayments = new ArrayList<AccountPaymentData>();
        this.totalAmount = totalAmount;
        this.personnel = personnel;
        this.paymentTypeId = paymentTypeId;
        this.transactionDate = transactionDate;
    }
    
    public List<AccountPaymentData> getAccountPayments() {
        return accountPayments;
    }

    public Short getPaymentTypeId() {
        return paymentTypeId;
    }

    public PersonnelBO getPersonnel() {
        return personnel;
    }

    public Date getReceiptDate() {
        return receiptDate;
    }

    public String getReceiptNum() {
        return receiptNum;
    }

    public Money getTotalAmount() {
        return totalAmount;
    }

    public Date getTransactionDate() {
        return transactionDate;
    }

    public CustomerBO getCustomer() {
        return customer;
    }

    public void setCustomer(CustomerBO customer) {
        this.customer = customer;
    }

    public boolean isAdjustment() {
		return adjustment;
	}

	public void setAdjustment(boolean adjustment) {
		this.adjustment = adjustment;
	}

    public boolean isAllowOverpayment() {
        return allowOverpayment;
    }

    public void setAllowOverpayment(boolean allowOverpayment) {
        this.allowOverpayment = allowOverpayment;
    }

    public void setReceiptDate(Date receiptDate) {
        this.receiptDate = receiptDate;
    }

    public void setReceiptNum(String receiptNum) {
        this.receiptNum = receiptNum;
    }

    public void addAccountPaymentData(AccountPaymentData accountPaymentData) {
        accountPayments.add(accountPaymentData);
    }

    public String getComment() {
        return this.comment;
    }

    public void setComment(String comment) {
        this.comment = comment;
    }

    public void setTransactionDate(Date date) {
        this.transactionDate = date;
    }

    public Money getOverpaymentAmount() {
        return overpaymentAmount;
    }

    public void setOverpaymentAmount(Money overpaymentAmount) {
        this.overpaymentAmount = overpaymentAmount;
    }

    public AccountPaymentEntity getOtherTransferPayment() {
        return otherTransferPayment;
    }

    public void setOtherTransferPayment(AccountPaymentEntity otherTransferPayment) {
        this.otherTransferPayment = otherTransferPayment;
    }

    public AccountPaymentEntity getParentPayment() {
        return parentPayment;
    }

    public void setParentPayment(AccountPaymentEntity parentPayment) {
        this.parentPayment = parentPayment;
    }

}