001/*
002 * Copyright 2006 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 */
016package org.kuali.ole.gl.batch.service;
017
018import java.util.Collection;
019
020import org.kuali.ole.gl.businessobject.Balance;
021import org.kuali.ole.gl.businessobject.Transaction;
022
023/**
024 * This interface declares methods needed for posting transactions to the appropriate balance records.
025 */
026public interface BalanceCalculator {
027    /**
028     * Given a collection of balance records, returns the balance that the given transaction would post to
029     * or creates a new balance record
030     * 
031     * @param balanceList a Collection of balance records
032     * @param t the transaction to post
033     * @return the balance to post against
034     */
035    public Balance findBalance(Collection balanceList, Transaction t);
036
037    /**
038     * Updates the balance based on the given transaction
039     * 
040     * @param t the transaction to post
041     * @param b the balance being posted against
042     */
043    public void updateBalance(Transaction t, Balance b);
044}