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

All Known Implementing Classes:

CashReceiptCoverSheetServiceImpl

public interface CashReceiptCoverSheetService

Service for handling creation of the cover sheet of the CashReceiptDocument

Method Summary

void	generateCoverSheet(CashReceiptDocument document, String searchPath, OutputStream outputStream) Generate a cover sheet for the CashReceiptDocument.
boolean	isCoverSheetPrintingAllowed(CashReceiptDocument crDoc) This method determines whether or not cover sheet printing is allowed for the provided cash receipt document.

Method Detail

isCoverSheetPrintingAllowed

boolean isCoverSheetPrintingAllowed(CashReceiptDocument crDoc)

This method determines whether or not cover sheet printing is allowed for the provided cash receipt document.

Parameters:

crDoc - The document that the cover sheet will be printed for.

Returns:

True if coverSheet printing is allowed for the given CashReceiptDocument, false otherwise.

generateCoverSheet

void generateCoverSheet(CashReceiptDocument document,
                        String searchPath,
                        OutputStream outputStream)
                        throws Exception

Generate a cover sheet for the CashReceiptDocument. An OutputStream is written to for the coversheet.

Parameters:

document - The CashReceiptDocument the cover sheet is being generated for.

searchPath - A directory path used to identify the path to the template that will be used for creating this cover sheet.

OutputStream - The output stream that the printable cover sheet will be piped to.

Throws:

Exception - Thrown if there are any problems generating the cover sheet.