org.kuali.kfs.module.ar.document.service

Interface DunningLetterService

All Known Implementing Classes:

DunningLetterServiceImpl

public interface DunningLetterService

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	createDunningLettersForAllResults(Collection<GenerateDunningLettersLookupResult> results) Creates a byte stream of pdfs for all dunning letters created for the given GenerateDunningLettersLookupResult.
boolean	createZipOfPDFs(byte[] report, ByteArrayOutputStream baos) This method generates the actual pdf files to print.
Collection<GenerateDunningLettersLookupResult>	getPopulatedGenerateDunningLettersLookupResults(Collection<ContractsGrantsInvoiceDocument> invoices) This helper method returns a list of award lookup results based on the Generate Dunning Letters lookup
boolean	isValidOrganizationForTemplate(DunningLetterTemplate template, org.kuali.rice.kim.api.identity.Person user) Determines if the given DunningLetterTemplate's organization is valid for the given user.

Method Detail

createDunningLettersForAllResults

byte[] createDunningLettersForAllResults(Collection<GenerateDunningLettersLookupResult> results)
                                         throws com.lowagie.text.DocumentException,
                                                IOException

Creates a byte stream of pdfs for all dunning letters created for the given GenerateDunningLettersLookupResult.

Parameters:

results - the dunning letter lookup results to create pdfs for

Returns:

a byte stream of PDFS

Throws:

com.lowagie.text.DocumentException

IOException

createZipOfPDFs

boolean createZipOfPDFs(byte[] report,
                      ByteArrayOutputStream baos)
                        throws IOException

This method generates the actual pdf files to print.

Parameters:

report -

baos -

Returns:

Throws:

IOException

isValidOrganizationForTemplate

boolean isValidOrganizationForTemplate(DunningLetterTemplate template,
                                     org.kuali.rice.kim.api.identity.Person user)

Determines if the given DunningLetterTemplate's organization is valid for the given user.

Parameters:

template - the template to check the organization of

user - the user attempting to use the template

Returns:

true if the current user can use the template, false otherwise

getPopulatedGenerateDunningLettersLookupResults

Collection<GenerateDunningLettersLookupResult> getPopulatedGenerateDunningLettersLookupResults(Collection<ContractsGrantsInvoiceDocument> invoices)

This helper method returns a list of award lookup results based on the Generate Dunning Letters lookup

Parameters:

invoices - the invoices to convert into DunningLetterDistributionLookupResult data transfer objects

Returns:

a Collection of DunningLetterDistributionLookupResult data transfer objects