org.kuali.kfs.module.bc.document.service
Interface BudgetRequestImportService

All Known Implementing Classes:

BudgetRequestImportServiceImpl

public interface BudgetRequestImportService

Describes services related to budget construction request import

Method Summary

void	generatePdf(List<String> errorMessages, ByteArrayOutputStream baos) Generates the log file
List<String>	loadBudget(org.kuali.rice.kim.bo.Person user, String fileType, Integer budgetYear) Loads all budget request records that do not have error codes
List	processImportFile(InputStream fileImportStream, String principalId, String fieldSeperator, String textDelimiter, String fileType, Integer budgetYear) Takes an import request file (either monthly or annual) and creates the BudgetConstructionMove objects for each line of the file.
List<String>	validateData(Integer budgetYear, String principalId) Checks the imported request records for valid data.

Method Detail

processImportFile

List processImportFile(InputStream fileImportStream,
                       String principalId,
                       String fieldSeperator,
                       String textDelimiter,
                       String fileType,
                       Integer budgetYear)
                       throws IOException

Takes an import request file (either monthly or annual) and creates the BudgetConstructionMove objects for each line of the file. If any errors are encounterd, file processing stops. If no errors are encountered an empty list is returned.

Parameters:

fileImportStream -

fieldSeperator -

textDelimiter -

fileType -

Returns:

list of errors encountered during file processing

Throws:

IOException

generatePdf

void generatePdf(List<String> errorMessages,
                 ByteArrayOutputStream baos)
                 throws com.lowagie.text.DocumentException

Generates the log file

Parameters:

errorMessages -

baos -

Throws:

com.lowagie.text.DocumentException

validateData

List<String> validateData(Integer budgetYear,
                          String principalId)

Checks the imported request records for valid data. Sets error codes on invalid records.

Returns:

true if no data validation errors were found. false otherwise

loadBudget

List<String> loadBudget(org.kuali.rice.kim.bo.Person user,
                        String fileType,
                        Integer budgetYear)
                        throws Exception

Loads all budget request records that do not have error codes

Returns:

Throws:

Exception