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.Encumbrance;
21 import org.kuali.ole.gl.businessobject.Transaction;
22
23 /**
24 * An interface which declares the methods needed to post a transaction against an encumbrance
25 */
26 public interface EncumbranceCalculator {
27 /**
28 * This method is used by the balance inquiry screens. It will take a list of selected encumbrances and a pending entry. It will
29 * return the Encumbrance row that is affected by the transaction.
30 *
31 * @param encumbranceList list of Encumbrance objects
32 * @param t A transaction
33 * @return the matching Encumbrance from the list or null if not applicable
34 */
35 public Encumbrance findEncumbrance(Collection encumbranceList, Transaction t);
36
37 /**
38 * This will update the amounts in an Encumbrance records based on the data in the transaction.
39 *
40 * @param t the transaction to compare
41 * @param enc An encumbrance to update
42 */
43 public void updateEncumbrance(Transaction t, Encumbrance enc);
44 }