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.ar.batch.service;
017    
018    import org.kuali.kfs.module.ar.batch.vo.CustomerInvoiceWriteoffBatchVO;
019    import org.kuali.rice.kim.bo.Person;
020    
021    /**
022     * 
023     * Accepts a write-off batch VO object, populated with a list of invoices to write off,
024     * and creates the correct XML file and drops it in the batch system for processing.
025     * 
026     * Actual processing of this happens later, and asynchronously.
027     * 
028     * @return Returns a true or false, depending on whether the call succeeded or not.
029     */
030    public interface CustomerInvoiceWriteoffBatchService {
031    
032        public boolean loadFiles();
033        
034        /**
035         * 
036         * Accepts a batch VO full of invoiceNumbers to be written off in batch.  Creates an XML file and 
037         * drops it in the batch service staging area, to be processed next time the job runs.
038         * 
039         * @param user KIM person who is credited with creating the batch file.
040         * @param writeoffBatchVO Populated batch VO full of invoice numbers.
041         * @return True if everything worked, False if it failed.
042         */
043        public String createBatchDrop(Person user, CustomerInvoiceWriteoffBatchVO writeoffBatchVO);
044        
045    }