/*
This file is part of Cyclos (www.cyclos.org).
A project of the Social Trade Organisation (www.socialtrade.org).
Cyclos 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 2 of the License, or
(at your option) any later version.
Cyclos 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 Cyclos; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package nl.strohalm.cyclos.dao.accounts.loans;
import java.util.List;
import nl.strohalm.cyclos.dao.BaseDAO;
import nl.strohalm.cyclos.dao.DeletableDAO;
import nl.strohalm.cyclos.dao.InsertableDAO;
import nl.strohalm.cyclos.dao.UpdatableDAO;
import nl.strohalm.cyclos.entities.accounts.loans.LoanPayment;
import nl.strohalm.cyclos.entities.accounts.loans.LoanPaymentQuery;
import nl.strohalm.cyclos.entities.exceptions.DaoException;
import nl.strohalm.cyclos.services.transactions.TransactionSummaryVO;
/**
* Data access object interface for loans payments
* @author rafael
*/
public interface LoanPaymentDAO extends BaseDAO<LoanPayment>, UpdatableDAO<LoanPayment>, InsertableDAO<LoanPayment>, DeletableDAO<LoanPayment> {
/**
* Returns a summary for loan payments, according to the filter. The status is required. For OPEN, EXPIRED and DISCARDED, the amount will be the
* remaining amount (amount - repaidAmount). For REPAID, just the repaidAmount. If any exception is thrown by the underlying implementation, it
* should be wrapped by a DaoException.
*/
TransactionSummaryVO paymentsSummary(LoanPaymentQuery query) throws DaoException;
/**
* Searches for loan payments, ordering by expiration date. If no entity can be found, returns an empty list. If any exception is thrown by the
* underlying implementation, it should be wrapped by a DaoException.
*
* @throws DaoException
*/
List<LoanPayment> search(LoanPaymentQuery query) throws DaoException;
}