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    /**
019     * This class defines methods an OrganizationSalarySettingSearchService must provide The OrganizationSalarySettingSearchService
020     * provides methods that build and clean the temporary tables used in the Organization Budgeted Position and Incumbent lookups. It
021     * is assumed that the Organization Tree exists and that the user has selected at least one organization before deriving the list of
022     * budgeted (funded) positions or incumbents.
023     */
024    public interface OrganizationSalarySettingSearchService {
025    
026        /**
027         * This method populates BudgetConstructionIntendedIncumbentSelect with rows associated with a set of selected organizations in
028         * the Organization Tree for the user and that have active funding (PendingBudgetConstructionAppointmentFunding).
029         * 
030         * @param principalName
031         * @param universityFiscalYear
032         */
033        public void buildIntendedIncumbentSelect(String principalName, Integer universityFiscalYear);
034    
035        /**
036         * This method depopulates BudgetConstructionIntendedIncumbentSelect rows associated with a user
037         * 
038         * @param principalName
039         */
040        public void cleanIntendedIncumbentSelect(String principalName);
041    
042        /**
043         * This method populates BudgetConstructionPositionSelect with rows associated with a set of selected organizations in the
044         * Organization Tree for the user and that are associated with BudgetConstructionPosition (ld_bcn_pos_t) using the
045         * positionDepartmentIdentifier (pos_dept_id))
046         * 
047         * @param principalName
048         * @param universityFiscalYear
049         */
050        public void buildPositionSelect(String principalName, Integer universityFiscalYear);
051    
052        /**
053         * This method depopulates BudgetConstructionPositionSelect rows associated with a user
054         * 
055         * @param principalName
056         */
057        public void cleanPositionSelect(String principalName);
058    }
059