001    /*
002     * Copyright 2011 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     */
016    package org.kuali.kfs.module.purap.service;
017    
018    import java.util.List;
019    
020    import org.kuali.kfs.module.purap.businessobject.CreditMemoItem;
021    import org.kuali.kfs.module.purap.businessobject.PaymentRequestItem;
022    
023    public interface PurapAccountRevisionService {
024        /**
025         * This method will identify the changes happened to existing payment request accounting lines and update the account change
026         * history table. If new lines are added, then new account history lines are added too.
027         * 
028         * @param paymentRequestItems Items from payment request document
029         * @param postingYear Posting year
030         * @param postingPeriodCode Posting period code
031         */
032        void savePaymentRequestAccountRevisions(List<PaymentRequestItem> paymentRequestItems, Integer postingYear, String postingPeriodCode);
033    
034        /**
035         * This method will identify the changes happened to existing credit memo accounting lines and update the account change history
036         * table. If new lines are added, then new account history lines are added too.
037         * 
038         * @param paymentRequestItems Items from payment request document
039         * @param postingYear Posting year
040         * @param postingPeriodCode Posting period code
041         */
042        void saveCreditMemoAccountRevisions(List<CreditMemoItem> creditMemoItems, Integer postingYear, String postingPeriodCode);
043    
044        /**
045         * This method will negate all existing payment request account line revisions
046         * 
047         * @param paymentRequestItems Items from payment request document
048         * @param postingYear Posting year
049         * @param postingPeriodCode Posting period code
050         */
051        void cancelPaymentRequestAccountRevisions(List<PaymentRequestItem> paymentRequestItems, Integer postingYear, String postingPeriodCode);
052    
053        /**
054         * This method will negate all existing credit memo account revision lines
055         * 
056         * @param paymentRequestItems Items from payment request document
057         * @param postingYear Posting year
058         * @param postingPeriodCode Posting period code
059         */
060        void cancelCreditMemoAccountRevisions(List<CreditMemoItem> creditMemoItems, Integer postingYear, String postingPeriodCode);
061    }