01: /*
02: * Copyright 2007 The Kuali Foundation.
03: *
04: * Licensed under the Educational Community License, Version 1.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.opensource.org/licenses/ecl1.php
09: *
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.module.financial.service;
17:
18: import java.util.Date;
19:
20: import org.kuali.module.financial.document.DisbursementVoucherDocument;
21:
22: /**
23: *
24: * This service interface defines the methods that a DisbursementVoucherExtractService implementation must provide.
25: *
26: */
27: public interface DisbursementVoucherExtractService {
28:
29: /**
30: * Extract all disbursement vouchers that need to be paid from the database and prepares them for payment.
31: *
32: * @return True if the extraction of payments is successful, false if not.
33: */
34: public boolean extractPayments();
35:
36: /**
37: * Cancels a disbursement voucher completely, because its payment has been canceled
38: * @param dv the disbursement voucher to cancel
39: */
40: public abstract void cancelExtractedDisbursementVoucher(
41: DisbursementVoucherDocument dv, java.sql.Date processDate);
42:
43: /**
44: * Resets the disbursement voucher so that it can be reextracted
45: * @param dv the disbursement voucher to reset for reextraction
46: */
47: public abstract void resetExtractedDisbursementVoucher(
48: DisbursementVoucherDocument dv, java.sql.Date processDate);
49:
50: /**
51: * Returns the disbursement voucher document associated with the given document number
52: * @param documentNumber the id of the document to retrieve
53: * @return the DV document if found, or null
54: */
55: public abstract DisbursementVoucherDocument getDocumentById(
56: String documentNumber);
57:
58: /**
59: * Marks a disbursement voucher as paid
60: * @param dv the disbursement voucher to mark
61: * @param processDate the date when the dv was paid
62: */
63: public abstract void markDisbursementVoucherAsPaid(
64: DisbursementVoucherDocument dv, java.sql.Date processDate);
65: }
|