org.kuali.kfs.fp.document.service
Interface DisbursementVoucherCoverSheetService

All Known Implementing Classes:

DisbursementVoucherCoverSheetServiceImpl

public interface DisbursementVoucherCoverSheetService

This service interface defines the methods that a DisbursementVoucherCoverSheetService implementation must provide.

Method Summary

void	generateDisbursementVoucherCoverSheet(String templateDirectory, String templateName, DisbursementVoucherDocument document, OutputStream outputStream) Generates a disbursement voucher cover sheet.
boolean	isCoverSheetPrintable(DisbursementVoucherDocument document) checks the status of the document to see if the cover sheet is printable

Method Detail

generateDisbursementVoucherCoverSheet

void generateDisbursementVoucherCoverSheet(String templateDirectory,
                                           String templateName,
                                           DisbursementVoucherDocument document,
                                           OutputStream outputStream)
                                           throws com.lowagie.text.DocumentException,
                                                  IOException

Generates a disbursement voucher cover sheet.

Parameters:

templateDirectory - The file system directory which contains the template.

templateName - The name of the template file used to generate the cover sheet.

document - The DisbursementVoucherDocument used to generate the cover sheet.

outputStream - The stream to write out the new cover sheet.

Throws:

com.lowagie.text.DocumentException - Thrown if there is a problem pulling data from the document to create the cover sheet.

IOException - Thrown if there is a problem writing the cover sheet to the output stream.

isCoverSheetPrintable

boolean isCoverSheetPrintable(DisbursementVoucherDocument document)

checks the status of the document to see if the cover sheet is printable

Parameters:

document - submitted document

Returns:

true if document is not canceled, initiated, disapproved, exception, or saved