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.service;
017    
018    import java.util.List;
019    
020    import org.kuali.kfs.module.bc.BCConstants.AccountSalarySettingOnlyCause;
021    import org.kuali.kfs.module.bc.document.BudgetConstructionDocument;
022    
023    /**
024     * This provides methods specific to system parameters for the Budget module
025     */
026    public interface BudgetParameterService {
027    
028        /**
029         * Returns a system parameter value as a list. If the parameter doesn't exist, a null list is returned and an info message is
030         * written to the log
031         * 
032         * @param componentClass
033         * @param parameterName
034         * @return
035         */
036        public List getParameterValues(Class componentClass, String parameterName);
037    
038        /**
039         * determines if a BudgetConstructionDocument's account is a salary setting only account returns
040         * AccountSalarySettingOnlyCause.NONE if not and if both system parameters don't exist
041         * 
042         * @param bcDoc
043         * @return
044         */
045        public AccountSalarySettingOnlyCause isSalarySettingOnlyAccount(BudgetConstructionDocument bcDoc);
046    
047        /**
048         * returns a string containing the allowed revenue or expenditure object types setup in the Budget Construction parameter space.
049         * this string is typically used in the lookup search criteria
050         * 
051         * @param isRevenue
052         * @return
053         */
054        public String getLookupObjectTypes(boolean isRevenue);
055    }