001    /**
002     * Copyright 2004-2013 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.hr.time.principal.service;
017    
018    import java.util.Date;
019    import java.util.List;
020    import org.kuali.hr.time.principal.PrincipalHRAttributes;
021    import org.springframework.cache.annotation.Cacheable;
022    
023    public interface PrincipalHRAttributesService {
024            /**
025             * Fetch PrincipalCalendar object at a particular date
026             * @param principalId
027             * @param asOfDate
028             * @return
029             */
030        @Cacheable(value= PrincipalHRAttributes.CACHE_NAME, key="'principalId=' + #p0 + '|' + 'asOfDate=' + #p1")
031            public PrincipalHRAttributes getPrincipalCalendar(String principalId, Date asOfDate);
032    
033            /**
034             * Fetch inactive PrincipalHRAttributes object at a particular date
035             * @param principalId
036             * @param asOfDate
037             * @return
038             */
039        public PrincipalHRAttributes getInactivePrincipalHRAttributes(String principalId, Date asOfDate);
040            /**
041             * Fetch PrincipalHRAttributes object with given id
042             * @param hrPrincipalAttributeId
043             * @return
044             */
045        public PrincipalHRAttributes getPrincipalHRAttributes(String hrPrincipalAttributeId);
046        
047        public List<PrincipalHRAttributes> getAllActivePrincipalHrAttributesForPrincipalId(String principalId, Date asOfDate);
048        
049        public List<PrincipalHRAttributes> getAllInActivePrincipalHrAttributesForPrincipalId(String principalId, Date asOfDate);
050        
051        public PrincipalHRAttributes getMaxTimeStampPrincipalHRAttributes(String principalId);
052        
053        /*
054         * Fetch list of PrincipalHRAttributes that become active for given principalId and date range
055         */
056        public List<PrincipalHRAttributes> getActivePrincipalHrAttributesForRange(String principalId, Date startDate, Date endDate);
057        /*
058         * Fetch list of PrincipalHRAttributes that become inactive for given principalId and date range
059         */
060        public List<PrincipalHRAttributes> getInactivePrincipalHRAttributesForRange(String principalId, Date startDate, Date endDate);  
061        /**
062         * Fetch list of PrincipalHRAttributes using given parameters
063         * @param principalId
064         * @param fromEffdt
065         * @param toEffdt
066         * @param active
067         * @param showHistory
068         * @return
069         */
070        public List<PrincipalHRAttributes> getPrincipalHrAtributes(String principalId, java.sql.Date fromEffdt, java.sql.Date toEffdt,String active, String showHistory);
071    }