View Javadoc

1   /*
2    * Copyright 2006 The Kuali Foundation
3    * 
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    * http://www.opensource.org/licenses/ecl2.php
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.ole.gl.batch.service;
17  
18  import java.util.Collection;
19  
20  import org.kuali.ole.gl.businessobject.Balance;
21  import org.kuali.ole.gl.businessobject.Transaction;
22  
23  /**
24   * This interface declares methods needed for posting transactions to the appropriate balance records.
25   */
26  public interface BalanceCalculator {
27      /**
28       * Given a collection of balance records, returns the balance that the given transaction would post to
29       * or creates a new balance record
30       * 
31       * @param balanceList a Collection of balance records
32       * @param t the transaction to post
33       * @return the balance to post against
34       */
35      public Balance findBalance(Collection balanceList, Transaction t);
36  
37      /**
38       * Updates the balance based on the given transaction
39       * 
40       * @param t the transaction to post
41       * @param b the balance being posted against
42       */
43      public void updateBalance(Transaction t, Balance b);
44  }