org.kuali.kfs.sys.service
Interface ReportGenerationService

All Known Implementing Classes:

ReportGenerationServiceImpl

public interface ReportGenerationService

To provide utilities that can generate reports

Method Summary

String	buildFullFileName(Date runDate, String directory, String fileName, String extension) build a full file name with the given information.
void	generateReportToOutputStream(Map<String,Object> reportData, Object dataSource, String template, ByteArrayOutputStream baos) generate a report as PDF file and outputs to stream
void	generateReportToPdfFile(Map<String,Object> reportData, Object dataSource, String template, String reportFileName) generate a report as PDF file with the given file name
void	generateReportToPdfFile(Map<String,Object> reportData, String template, String reportFileName) generate a report as PDF file with the given file name

Method Detail

generateReportToPdfFile

void generateReportToPdfFile(Map<String,Object> reportData,
                             String template,
                             String reportFileName)

generate a report as PDF file with the given file name

Parameters:

reportData - the data being written into the PDF report file

template - the report template full file name

reportFileName - the full name of the generated PDF file

generateReportToPdfFile

void generateReportToPdfFile(Map<String,Object> reportData,
                             Object dataSource,
                             String template,
                             String reportFileName)

generate a report as PDF file with the given file name

Parameters:

reportData - the data being written into the PDF report file

dataSource - the data source being used for the PDF report

template - the report template full file name

reportFileName - the full name of the generated PDF file

generateReportToOutputStream

void generateReportToOutputStream(Map<String,Object> reportData,
                                  Object dataSource,
                                  String template,
                                  ByteArrayOutputStream baos)

generate a report as PDF file and outputs to stream

Parameters:

reportData - the data being written into the PDF report file

dataSource - the data source being used for the PDF report

template - the report template full file name

reportFileName - the output stream for sending back contents

buildFullFileName

String buildFullFileName(Date runDate,
                         String directory,
                         String fileName,
                         String extension)

build a full file name with the given information. The format of the file name is _.

Parameters:

directory - the directory where the file would be located

fileName - the given file name without file extension

extension - the given file extension

runDate - the run date which is used to generate a timestamp

Returns:

a full file name built from the given information.