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.Encumbrance;
021import org.kuali.ole.gl.businessobject.Transaction;
022
023/**
024 * An interface which declares the methods needed to post a transaction against an encumbrance
025 */
026public interface EncumbranceCalculator {
027    /**
028     * This method is used by the balance inquiry screens. It will take a list of selected encumbrances and a pending entry. It will
029     * return the Encumbrance row that is affected by the transaction.
030     * 
031     * @param encumbranceList list of Encumbrance objects
032     * @param t A transaction
033     * @return the matching Encumbrance from the list or null if not applicable
034     */
035    public Encumbrance findEncumbrance(Collection encumbranceList, Transaction t);
036
037    /**
038     * This will update the amounts in an Encumbrance records based on the data in the transaction.
039     * 
040     * @param t the transaction to compare
041     * @param enc An encumbrance to update
042     */
043    public void updateEncumbrance(Transaction t, Encumbrance enc);
044}