1 /*
2 * Copyright 2006-2011 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
17 package org.kuali.rice.shareddata.api.postalcode;
18
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 public interface PostalCodeContract extends Versioned, Inactivatable {
29 /**
30 * This the county code for the PostalCode. This cannot be null or a blank string.
31 *
32 * @return code
33 */
34 String getCode();
35
36 /**
37 * This the postal country code for the PostalCode. This cannot be null or a blank string.
38 *
39 * @return postal country code
40 */
41 String getCountryCode();
42
43 /**
44 * This the postal state code for the PostalCode. This can be null.
45 *
46 * @return postal state code
47 */
48 String getStateCode();
49
50 /**
51 * This the postal state code for the PostalCode. This can be null.
52 *
53 * @return postal state code
54 */
55 String getCityName();
56
57 /**
58 * This the county code for the PostalCode. This cannot be null.
59 *
60 * @return postal state code
61 */
62 String getCountyCode();
63 }