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.util.List;
019
020import org.kuali.ole.pdp.businessobject.PaymentGroup;
021
022public interface PaymentGroupDao {
023
024    /**
025     * Get all the disbursement numbers for a specific process of a certain type
026     * 
027     * @param pid
028     * @param disbursementType
029     * @return
030     */
031    public List<Integer> getDisbursementNumbersByDisbursementType(Integer pid, String disbursementType);
032    
033    /**
034     * Get all the disbursement numbers for a specific process of a certain type for a certain bank
035     * 
036     * @param pid
037     * @param disbursementType
038     * @param bankCode the bank code to find disbursement numbers for
039     * @return
040     */
041    public abstract List<Integer> getDisbursementNumbersByDisbursementTypeAndBankCode(Integer pid, String disbursementType, String bankCode);
042
043    /**
044     * Gets list of ach payments in which an advice notification has not been sent
045     * 
046     * @return List<PaymentGroup>
047     */
048    public List<PaymentGroup> getAchPaymentsNeedingAdviceNotification();
049    
050    /**
051     * Given a process id and a disbursement type, finds a distinct list of bank codes used by payment groups within that payment process
052     * @param pid payment process to query payment groups of
053     * @param disbursementType the type of disbursements to query
054     * @return a sorted List of bank codes
055     */
056    public abstract List<String> getDistinctBankCodesForProcessAndType(Integer pid, String disbursementType);
057
058}