1 /*
2 * Copyright 2007 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.ole.pdp.service;
17
18 import java.util.Iterator;
19 import java.util.List;
20
21 import org.kuali.ole.pdp.businessobject.PaymentDetail;
22
23 public interface PaymentDetailService {
24
25 /**
26 * Return an iterator of all the payment details for a specific disbursement number
27 *
28 * @param disbursementNumber
29 * @return
30 */
31 public Iterator getByDisbursementNumber(Integer disbursementNumber);
32
33 /**
34 * This will return an iterator of all the cancelled payment details that haven't already been processed
35 *
36 * @param organization
37 * @param subUnit
38 * @return
39 */
40 public Iterator getUnprocessedCancelledDetails(String organization, List<String> subUnits);
41
42 /**
43 * This will return an iterator of all the paid payment details that haven't already been processed
44 *
45 * @param organization
46 * @param subUnit
47 * @return
48 */
49 public Iterator getUnprocessedPaidDetails(String organization, List<String> subUnits);
50
51 /**
52 * Returns all PaymentDetail records with the given disbursement number and a group with the given process id, disbursement type, and bank code
53 * @param disbursementNumber the disbursement number of the payment details to find
54 * @param processId the process id of the payment group of payment details to find
55 * @param disbursementType the disbursement type of the payment group of payment details to find
56 * @param bankCode the bank code of the payment group of payment details to find
57 * @return an iterator of PaymentDetail records matching the given criteria
58 */
59 public abstract Iterator<PaymentDetail> getByDisbursementNumber(Integer disbursementNumber, Integer processId, String disbursementType, String bankCode);
60 }