org.mifos.accounts.business.AccountActionDateEntity.java Source code

Introduction

Here is the source code for org.mifos.accounts.business.AccountActionDateEntity.java

Source

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

import java.sql.Date;
import java.util.concurrent.TimeUnit;

import org.joda.time.DateTime;
import org.joda.time.Days;
import org.joda.time.LocalDate;
import org.mifos.accounts.util.helpers.PaymentStatus;
import org.mifos.application.master.business.MifosCurrency;
import org.mifos.customers.business.CustomerBO;
import org.mifos.framework.business.AbstractEntity;
import org.mifos.framework.util.helpers.DateUtils;

public abstract class AccountActionDateEntity extends AbstractEntity
        implements Comparable<AccountActionDateEntity> {

    protected final Integer actionDateId;
    protected AccountBO account;
    protected final CustomerBO customer;
    protected Short installmentId;
    protected Date actionDate;
    protected Short paymentStatus;
    protected Date paymentDate;

    protected AccountActionDateEntity(final AccountBO account, final CustomerBO customer, final Short installmentId,
            final Date actionDate, final PaymentStatus paymentStatus) {
        this.actionDateId = null;
        this.account = account;
        this.customer = customer;
        this.installmentId = installmentId;
        this.actionDate = actionDate;
        if (paymentStatus != null) {
            this.paymentStatus = paymentStatus.getValue();
        }
    }

    public Integer getActionDateId() {
        return actionDateId;
    }

    public AccountBO getAccount() {
        return account;
    }

    public CustomerBO getCustomer() {
        return customer;
    }

    public Short getInstallmentId() {
        return installmentId;
    }

    public Date getActionDate() {
        return actionDate;
    }

    public void setActionDate(final Date actionDate) {
        this.actionDate = actionDate;
    }

    public Date getPaymentDate() {
        return paymentDate;
    }

    public void setPaymentDate(final Date paymentDate) {
        this.paymentDate = paymentDate;
    }

    /**
     * Most callers will want to call {@link #isPaid()} instead.
     */
    public Short getPaymentStatus() {
        return paymentStatus;
    }

    public PaymentStatus getPaymentStatusAsEnum() {
        return PaymentStatus.fromInt(paymentStatus);
    }

    void setPaymentStatus(final Short paymentStatus) {
        this.paymentStatus = paymentStatus;
    }

    public void setPaymentStatus(final PaymentStatus status) {
        this.paymentStatus = status.getValue();
    }

    public int compareDate(final java.util.Date date) {
        return getActionDate().compareTo(date);
    }

    public boolean isPaid() {
        return getPaymentStatusAsEnum() == PaymentStatus.PAID;
    }

    @Override
    public int compareTo(final AccountActionDateEntity obj) {
        return this.getInstallmentId().compareTo(obj.getInstallmentId());
    }

    public MifosCurrency getCurrency() {
        return account.getCurrency();
    }

    public boolean isDueToday() {
        return DateUtils.getDateWithoutTimeStamp(getActionDate().getTime())
                .equals(DateUtils.getCurrentDateWithoutTimeStamp());
    }

    public void setAccount(AccountBO account) {
        this.account = account;
    }

    public boolean isOn(LocalDate date) {
        return new LocalDate(this.actionDate).isEqual(date);
    }

    public boolean isBefore(LocalDate date) {
        return new LocalDate(this.actionDate).isBefore(date);
    }

    public boolean isBeforeOrOn(LocalDate date) {
        return isBefore(date) || isOn(date);
    }

    public boolean isAfter(LocalDate date) {
        return new LocalDate(this.actionDate).isAfter(date);
    }

    public boolean isOnOrAfter(LocalDate date) {
        return isOn(date) || isAfter(date);
    }

    public boolean isNotPaid() {
        return !isPaid();
    }

    public void setInstallmentId(Short installmentId) {
        this.installmentId = installmentId;
    }

    public Integer getDaysLate() {
        int daysLate = Days.daysBetween(new DateTime(getActionDate()),
                getPaymentDate() != null ? new DateTime(getPaymentDate()) : new DateTime()).getDays();
        return daysLate < 0 ? 0 : daysLate;
    }

}