001    /*
002     * Copyright 2011 The Kuali Foundation.
003     * 
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     * 
008     * http://www.opensource.org/licenses/ecl2.php
009     * 
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.kfs.module.bc.document.service;
017    
018    import java.io.ByteArrayOutputStream;
019    import java.io.InputStream;
020    import java.util.List;
021    
022    import org.kuali.kfs.module.bc.util.ExternalizedMessageWrapper;
023    import org.kuali.rice.kim.bo.Person;
024    
025    import com.lowagie.text.DocumentException;
026    
027    public interface PayrateImportService {
028        
029        /**
030         * Parses file and creates payrate holding records for each import line
031         * 
032         * @param fileImportStream
033         * @return
034         */
035        public boolean importFile(InputStream fileImportStream, List<ExternalizedMessageWrapper> messageList, String principalId);
036        
037        /**
038         * Processes all payrate holding records
039         */
040        public void update(Integer budgetYear, Person user, List<ExternalizedMessageWrapper> messageList, String principalId);
041        
042        /**
043         * Generates the log file
044         * 
045         * @param errorMessages
046         * @param baos
047         * @throws DocumentException
048         */
049        public void generatePdf(List<ExternalizedMessageWrapper> logMessages, ByteArrayOutputStream baos) throws DocumentException;
050        
051    }
052