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 org.kuali.ole.pdp.businessobject.LoadPaymentStatus;
19 import org.kuali.ole.pdp.businessobject.PaymentFileLoad;
20 import org.kuali.ole.sys.batch.BatchInputFileType;
21 import org.kuali.ole.sys.batch.InitiateDirectory;
22 import org.kuali.rice.krad.util.MessageMap;
23
24 /**
25 * Handles processing (validation, loading, and reporting) of incoming payment files.
26 */
27 public interface PaymentFileService extends InitiateDirectory{
28
29 /**
30 * Process all incoming payment files
31 *
32 * @param paymentInputFileType <code>BatchInputFileType</code> for payment files
33 */
34 public void processPaymentFiles(BatchInputFileType paymentInputFileType);
35
36 /**
37 * Performs hard edits on payment file
38 *
39 * @param paymentFile <code>PaymentFileLoad</code> containing parsed file contents
40 * @param errorMap <code>Map</code> that will hold errors encountered
41 */
42 public void doPaymentFileValidation(PaymentFileLoad paymentFile, MessageMap errorMap);
43
44 /**
45 * Performs soft edits of payment file data and loads records into database
46 *
47 * @param paymentFile <code>PaymentFileLoad</code> containing parsed file contents
48 * @param status <code>LoadPaymentStatus</code> containing status information for load
49 * @param incomingFileName string file name
50 */
51 public void loadPayments(PaymentFileLoad paymentFile, LoadPaymentStatus status, String incomingFileName);
52
53 /**
54 * Creates the PDP XML output which can be parsed to obtain load status information
55 *
56 * @param status <code>LoadPaymentStatus</code> containing status information for load
57 * @param inputFileName incomingFileName string file name
58 * @return true if output file was successfully created, false otherwise
59 */
60 public boolean createOutputFile(LoadPaymentStatus status, String inputFileName);
61
62 }
63