1 /**
2 * Copyright 2005-2012 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.location.api.postalcode;
17
18 import org.kuali.rice.core.api.mo.common.Coded;
19 import org.kuali.rice.core.api.mo.common.Versioned;
20 import org.kuali.rice.core.api.mo.common.active.Inactivatable;
21
22 /**
23 * This is the contract for a Postal Code. A postal code is assigned to different geographic regions
24 * in order to give each region an identifier.
25 *
26 * Examples of postal codes are Zip Codes in the United States and FSALDU in Canada.
27 *
28 * @author Kuali Rice Team (rice.collab@kuali.org)
29 */
30 public interface PostalCodeContract extends Versioned, Inactivatable, Coded {
31
32 /**
33 * This the postal country code for the PostalCode. This cannot be null or a blank string.
34 *
35 * @return postal country code
36 */
37 String getCountryCode();
38
39 /**
40 * This the postal state code for the PostalCode. This can be null.
41 *
42 * @return postal state code
43 */
44 String getStateCode();
45
46 /**
47 * This the postal state code for the PostalCode. This can be null.
48 *
49 * @return postal state code
50 */
51 String getCityName();
52
53 /**
54 * This the county code for the PostalCode. This cannot be null.
55 *
56 * @return postal state code
57 */
58 String getCountyCode();
59 }