01: /*
02: * Copyright 2006-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.io.IOException;
19: import java.io.OutputStream;
20:
21: import org.kuali.module.financial.document.DisbursementVoucherDocument;
22:
23: import com.lowagie.text.DocumentException;
24:
25: /**
26: * This service interface defines the methods that a DisbursementVoucherCoverSheetService implementation must provide.
27: *
28: */
29: public interface DisbursementVoucherCoverSheetService {
30:
31: /**
32: * Generates a disbursement voucher cover sheet.
33: *
34: * @param templateDirectory The file system directory which contains the template.
35: * @param templateName The name of the template file used to generate the cover sheet.
36: * @param document The DisbursementVoucherDocument used to generate the cover sheet.
37: * @param outputStream The stream to write out the new cover sheet.
38: * @throws DocumentException Thrown if there is a problem pulling data from the document to create the cover sheet.
39: * @throws IOException Thrown if there is a problem writing the cover sheet to the output stream.
40: */
41: public void generateDisbursementVoucherCoverSheet(
42: String templateDirectory, String templateName,
43: DisbursementVoucherDocument document,
44: OutputStream outputStream) throws DocumentException,
45: IOException;
46: }
|