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.service;
017    
018    import org.kuali.kfs.module.bc.businessobject.BudgetConstructionIntendedIncumbent;
019    import org.kuali.kfs.module.bc.exception.BudgetIncumbentAlreadyExistsException;
020    
021    /**
022     * define the service methods that are related to budget construction Intended Incumbent class
023     * 
024     * @see org.kuali.kfs.module.bc.businessobject.BudgetConstructionIntendedIncumbent
025     */
026    public interface BudgetConstructionIntendedIncumbentService {
027        
028        /**
029         * Retrieves a new incumbent record from an external system using <code>HumanResourcesPayrollService</code> then populates the
030         * record in the budget intended incumbent table.
031         * 
032         * @param emplid university id for the incumbent to pull
033         * @exception BudgetPositionAlreadyExistsException thrown when position is already in the budget table
034         */
035        public void pullNewIncumbentFromExternal(String emplid) throws BudgetIncumbentAlreadyExistsException;
036    
037        /**
038         * Refreshes an incumbent record from an external system using <code>HumanResourcesPayrollService</code> then updates the
039         * record in the budget intended incumbent table.
040         * 
041         * @param emplid university id for the incumbent to pull
042         */
043        public void refreshIncumbentFromExternal(String emplid);
044        
045        /**
046         * retrieve a Budget Construction Intended Incumbent object by its primary key - the employee id.
047         * 
048         * @param emplid the given employee id
049         * @return a Budget Construction Intended Incumbent object retrived by its primary key
050         */
051        public BudgetConstructionIntendedIncumbent getByPrimaryId(String emplid);
052    }