/*
 * eGov suite of products aim to improve the internal efficiency,transparency,
 *    accountability and the service delivery of the government  organizations.
 *
 *     Copyright (C) <2015>  eGovernments Foundation
 *
 *     The updated version of eGov suite of products as by eGovernments Foundation
 *     is available at http://www.egovernments.org
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     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 General Public License for more details.
 *
 *     You should have received a copy of the GNU General Public License
 *     along with this program. If not, see http://www.gnu.org/licenses/ or
 *     http://www.gnu.org/licenses/gpl.html .
 *
 *     In addition to the terms of the GPL license to be adhered to in using this
 *     program, the following additional terms are to be complied with:
 *
 *         1) All versions of this program, verbatim or modified must carry this
 *            Legal Notice.
 *
 *         2) Any misrepresentation of the origin of the material is prohibited. It
 *            is required that all modified versions of this material be marked in
 *            reasonable ways as different from the original version.
 *
 *         3) This license does not grant any rights to any user of the program
 *            with regards to rights under trademark law for use of the trade names
 *            or trademarks of eGovernments Foundation.
 *
 *   In case of any queries, you can reach eGovernments Foundation at contact@egovernments.org.
 */
package org.egov.collection.integration.models;

import org.egov.commons.EgwStatus;

import java.math.BigDecimal;
import java.util.Date;

public interface ReceiptInstrumentInfo {

    /**
     * @return the instrumentNumber
     */
    public abstract String getInstrumentNumber();

    /**
     * @return the instrumentDate
     */
    public abstract Date getInstrumentDate();

    /**
     * @return the instrumentType
     */
    public abstract String getInstrumentType();

    /**
     * @return the instrumentAmount
     */
    public abstract BigDecimal getInstrumentAmount();

    /**
     * @return the instrument status
     */
    public abstract EgwStatus getInstrumentStatus();

    /**
     * @return the transaction Number
     */
    public abstract String getTransactionNumber();

    /**
     * @return the transaction date
     */
    public abstract Date getTransactionDate();

    /**
     * @return true if the instrument is in bounced (dishonored) status, else
     *         false
     */
    public abstract boolean isBounced();

    /**
     * @return Bank name of the instrument (in case of cheque/dd/bank). Returns
     *         null in case of other types of instruments.
     */
    public abstract String getBankName();

    /**
     * @return Bank account number of the instrument (in case of bank challan).
     *         Returns null in case of other types of instruments.
     */
    public abstract String getBankAccountNumber();

    /**
     * @return Bank branch name of the instrument (in case of cheque/dd)
     */
    public abstract String getBankBranchName();

}