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.bc.document.validation;
017    
018    import org.kuali.kfs.module.bc.businessobject.PendingBudgetConstructionGeneralLedger;
019    import org.kuali.kfs.module.bc.document.BudgetConstructionDocument;
020    
021    /**
022     * Defines a rule for adding PendingBudgetGeneralLedgerLine rows to a Budget Construction Document.
023     * Invoked when a user clicks the Add button on the expenditure or revenue tab.
024     */
025    public interface AddPendingBudgetGeneralLedgerLineRule<D extends BudgetConstructionDocument, P extends PendingBudgetConstructionGeneralLedger> {
026        
027        /**
028         * Processes all the rules for this event and returns true if all rules passed
029         * 
030         * @param budgetConstructionDocument
031         * @param pendingBudgetConstructionGeneralLedger
032         * @param isRevenue
033         * @return
034         */
035        public boolean processAddPendingBudgetGeneralLedgerLineRules(D budgetConstructionDocument, P pendingBudgetConstructionGeneralLedger, boolean isRevenue);
036    
037    }