01: /*
02: * Copyright 2006 The Kuali Foundation.
03: *
04: * Licensed under the Educational Community License, Version 1.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.opensource.org/licenses/ecl1.php
09: *
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.module.gl.batch.poster;
17:
18: import java.util.Collection;
19:
20: import org.kuali.module.gl.bo.Encumbrance;
21: import org.kuali.module.gl.bo.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,
36: Transaction t);
37:
38: /**
39: * This will update the amounts in an Encumbrance records based on the data in the transaction.
40: *
41: * @param t the transaction to compare
42: * @param enc An encumbrance to update
43: */
44: public void updateEncumbrance(Transaction t, Encumbrance enc);
45: }
|