Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
CountyService |
|
| 1.0;1 |
1 | /* | |
2 | * Copyright 2008 The Kuali Foundation | |
3 | * | |
4 | * Licensed under the Educational Community License, Version 2.0 (the "License"); | |
5 | * you may not use this file except in compliance with the License. | |
6 | * You may obtain a copy of the License at | |
7 | * | |
8 | * http://www.opensource.org/licenses/ecl2.php | |
9 | * | |
10 | * Unless required by applicable law or agreed to in writing, software | |
11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
13 | * See the License for the specific language governing permissions and | |
14 | * limitations under the License. | |
15 | */ | |
16 | package org.kuali.rice.kns.service; | |
17 | ||
18 | import org.kuali.rice.kns.bo.County; | |
19 | ||
20 | public interface CountyService { | |
21 | ||
22 | /** | |
23 | * get a county object based on the given county code, state code and default country code. The default country code is set up | |
24 | * in the system. | |
25 | * | |
26 | * @param postalStateCode the given state code | |
27 | * @param countyCode the given state code | |
28 | * @return a county object based on the given county code, state code and default country code | |
29 | */ | |
30 | public County getByPrimaryId(String postalStateCode, String countyCode); | |
31 | ||
32 | /** | |
33 | * get a county object based on the given county code, state code and country code. | |
34 | * | |
35 | * @param postalCountryCode the given country code | |
36 | * @param postalStateCode the given state code | |
37 | * @param countyCode the given state code | |
38 | * @return a county object based on the given county code, state code and country code | |
39 | */ | |
40 | public County getByPrimaryId(String postalCountryCode, String postalStateCode, String countyCode); | |
41 | ||
42 | /** | |
43 | * get a county object based on the given county code, state code and default country code. The default country code is set up | |
44 | * in the system. If the given postal state code and county code are same as those of the given existing county, return the | |
45 | * existing county; otherwise, retrieve a county object. | |
46 | * | |
47 | * @param postalStateCode the given state code | |
48 | * @param countyCode the given state code | |
49 | * @param existingCounty the given existing county | |
50 | * @return a county object based on the given county code, state code and default country code if necessary | |
51 | */ | |
52 | public County getByPrimaryIdIfNecessary(String postalStateCode, String countyCode, County existingCounty); | |
53 | ||
54 | /** | |
55 | * get a county object based on the given county code, state code and default country code. The default country code is set up | |
56 | * in the system. If the given postal country code, state code and county code are same as those of the given existing county, | |
57 | * return the existing county; otherwise, retrieve a county object. | |
58 | * | |
59 | * @param postalCountryCode the given country code | |
60 | * @param postalStateCode the given state code | |
61 | * @param countyCode the given state code | |
62 | * @param existingCounty the given existing county | |
63 | * @return a county object based on the given county code, state code and country code if necessary | |
64 | */ | |
65 | public County getByPrimaryIdIfNecessary(String postalCountryCode, String postalStateCode, String countyCode, County existingCounty); | |
66 | } |