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.location.service;
017    
018    import org.kuali.hr.location.Location;
019    import org.springframework.cache.annotation.Cacheable;
020    
021    import java.sql.Date;
022    import java.util.List;
023    
024    public interface LocationService {
025            /**
026             * Get location as of a particular date
027             * @param location
028             * @param asOfDate
029             * @return {@link Location}
030             */
031        @Cacheable(value= Location.CACHE_NAME, key="'location=' + #p0 + '|' + 'asOfDate=' + #p1")
032            public Location getLocation(String location, Date asOfDate);
033            /**
034             * Get location by unique id
035             * @param hrLocationId
036             * @return
037             */
038        @Cacheable(value= Location.CACHE_NAME, key="'hrLocationId=' + #p0")
039            public Location getLocation(String hrLocationId);
040            /**
041             * Get location count by location
042             * @param location
043             * @return
044             */
045            public int getLocationCount(String location);
046    
047        List<Location> searchLocations(String location, String locationDescr, String active, String showHistory);
048    }