001/*
002 * Copyright 2007 The Kuali Foundation
003 * 
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 * 
008 * http://www.opensource.org/licenses/ecl2.php
009 * 
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.ole.pdp.dataaccess;
017
018import java.sql.Date;
019import java.util.Iterator;
020import java.util.List;
021
022import org.kuali.ole.pdp.businessobject.DailyReport;
023import org.kuali.ole.pdp.businessobject.DisbursementNumberRange;
024import org.kuali.ole.pdp.businessobject.PaymentDetail;
025
026public interface PaymentDetailDao {
027    /**
028     * @param custPaymentDocNbr
029     * @param fdocTypeCode
030     * @param orgCode the value of the system parameter PURAP_PDP_ORG_CODE
031     * @param subUnitCode the value of the system parameter PURAP_PDP_SUB_UNIT_CODE
032     * @return
033     */
034    public PaymentDetail getDetailForEpic(String custPaymentDocNbr, String fdocTypeCode, String orgCode, String subUnitCode);
035
036    /**
037     * Retrieves list of <code>DisbursementNumberRange</code> records for the given processing campus which are active and have
038     * range start date before or equal to the current date.
039     * 
040     * @param campus processing campus to retrieve ranges for
041     * @return List of <code>DisbursementNumberRange</code> records found
042     */
043    public List<DisbursementNumberRange> getDisbursementNumberRanges(String campus);
044
045    /**
046     * This returns the data required for the daily report
047     * 
048     * @param currentSqlDate the current Sql date
049     * @return
050     */
051    public List<DailyReport> getDailyReportData(Date currentSqlDate);
052
053    /**
054     * This will return an iterator of all the cancelled payment details that haven't already been processed
055     * 
056     * @param organization
057     * @param subUnit
058     * @return
059     */
060    public Iterator getUnprocessedCancelledDetails(String organization, List<String> subUnits);
061
062    /**
063     * This will return all the ACH payments that need an email sent
064     * 
065     * @return
066     */
067    public Iterator getAchPaymentsWithUnsentEmail();
068
069    /**
070     * This will return an iterator of all the paid payment details that haven't already been processed
071     * 
072     * @param organization
073     * @param subUnit
074     * @return
075     */
076    public Iterator getUnprocessedPaidDetails(String organization, List<String> subUnits);
077}