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.endow.batch.service;
017    
018    import java.util.Collection;
019    
020    import org.kuali.kfs.module.endow.businessobject.CurrentTaxLotBalance;
021    import org.kuali.kfs.module.endow.businessobject.KEMID;
022    import org.kuali.kfs.module.endow.businessobject.KEMIDCurrentAvailableBalance;
023    
024    /**
025     * This interface defines the batch job that would to update current tax lot balance records
026     */
027    public interface CurrentTaxLotBalanceUpdateService {
028    
029        /**
030         * At the end of each business processing cycle and in preparation for the next day's business, 
031         * the system will compile the information in the Holding Tax Lot Table along with calculations
032         * of market value and estimated income into a new table called the Current Tax Lot Balances.
033         * This table is used as the basis for balance inquiries as well as the source of data for 
034         * creating the Holding Archive records.
035         */
036        public boolean updateCurrentTaxLotBalances();
037        
038        /**
039         * Removes the all the records from the CurrentTaxLot table (END_CURR_TAX_LOT_BAL_T table).
040         */
041        
042        public abstract void clearAllCurrentTaxLotRecords();
043    
044        /**
045         * Saves the CurrentTaxLot record to the table (END_CURR_TAX_LOT_BAL_T).
046         */
047        public abstract void saveCurrentTaxLotRecord(CurrentTaxLotBalance currentTaxLotBalance);
048        
049    }