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.BCConstants.SynchronizationCheckType;
019    import org.kuali.kfs.module.bc.businessobject.Incumbent;
020    import org.kuali.kfs.module.bc.businessobject.Position;
021    import org.kuali.kfs.module.bc.exception.IncumbentNotFoundException;
022    import org.kuali.kfs.module.bc.exception.PositionNotFoundException;
023    
024    /**
025     * Provides service methods for obtaining information from an external payroll/hr system. Used primarily by the Budget Construction
026     * and Labor Distribution modules to provide position data in the KFS.
027     */
028    public interface HumanResourcesPayrollService {
029    
030        /**
031         * @param positionUnionCode
032         * @return
033         */
034        public boolean validatePositionUnionCode(String positionUnionCode);
035    
036        /**
037         * Pulls position data from an external system for the given position identifying fields and populates a <code>Position</code>
038         * object.
039         * 
040         * @param universityFiscalYear position fiscal year, part of record key
041         * @param positionNumber position number, part of record key
042         * @return <code>Position</code> object
043         * @exception PositionNotFoundException thrown if no data was found for the position key
044         * @see org.kuali.kfs.module.bc.businessobject.Position
045         */
046        public Position getPosition(Integer universityFiscalYear, String positionNumber) throws PositionNotFoundException;
047    
048        /**
049         * Pulls incumbent data from an external system for the given employee id and populates a <code>Incumbent</code> object.
050         * 
051         * @param emplid university id for the incumbent to pull
052         * @return <code>Incumbent</code> object
053         * @throws IncumbentNotFoundException thrown if no data was found for the employee id
054         * @see org.kuali.kfs.module.bc.businessobject.Incumbent
055         */
056        public Incumbent getIncumbent(String emplid) throws IncumbentNotFoundException;
057    
058        /**
059         * determine whether there is an active job for the given emplid on the specified position
060         * 
061         * @param emplid the given employee id
062         * @param positionNumber the specified position number
063         * @param fiscalYear the given fiscal year
064         * @param synchronizationCheckType the sync check type
065         * @return true there is an active job for the given emplid on the specified position; otherwise, false
066         */
067        public boolean isActiveJob(String emplid, String positionNumber, Integer fiscalYear, SynchronizationCheckType synchronizationCheckType);
068    }