001    /*
002     * Copyright 2011 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     */
016    package org.kuali.kfs.pdp.service;
017    
018    import java.util.Iterator;
019    import java.util.List;
020    
021    import org.kuali.kfs.pdp.businessobject.PaymentDetail;
022    
023    public interface PaymentDetailService {
024        
025        /**
026         * Return an iterator of all the payment details for a specific disbursement number
027         * 
028         * @param disbursementNumber
029         * @return
030         */
031        public Iterator getByDisbursementNumber(Integer disbursementNumber);
032    
033        /**
034         * This will return an iterator of all the cancelled payment details that haven't already been processed
035         * 
036         * @param organization
037         * @param subUnit
038         * @return
039         */
040        public Iterator getUnprocessedCancelledDetails(String organization, List<String> subUnits);
041    
042        /**
043         * This will return an iterator of all the paid payment details that haven't already been processed
044         * 
045         * @param organization
046         * @param subUnit
047         * @return
048         */
049        public Iterator getUnprocessedPaidDetails(String organization, List<String> subUnits);
050        
051        /**
052         * Returns all PaymentDetail records with the given disbursement number and a group with the given process id, disbursement type, and bank code
053         * @param disbursementNumber the disbursement number of the payment details to find
054         * @param processId the process id of the payment group of payment details to find
055         * @param disbursementType the disbursement type of the payment group of payment details to find
056         * @param bankCode the bank code of the payment group of payment details to find
057         * @return an iterator of PaymentDetail records matching the given criteria
058         */
059        public abstract Iterator<PaymentDetail> getByDisbursementNumber(Integer disbursementNumber, Integer processId, String disbursementType, String bankCode);
060    }