001/**
002 * Copyright 2005-2016 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 */
016package org.kuali.rice.location.api.postalcode;
017
018import org.kuali.rice.core.api.mo.common.Coded;
019import org.kuali.rice.core.api.mo.common.Versioned;
020import org.kuali.rice.core.api.mo.common.active.Inactivatable;
021
022/**
023 * This is the contract for a Postal Code.  A postal code is assigned to different geographic regions
024 * in order to give each region an identifier.
025 *
026 * Examples of postal codes are Zip Codes in the United States and FSALDU in Canada.
027 *
028 * @author Kuali Rice Team (rice.collab@kuali.org)
029 */
030public interface PostalCodeContract extends Versioned, Inactivatable, Coded {
031
032    /**
033     * This the postal country code for the PostalCode.  This cannot be null or a blank string.
034     *
035     * @return postal country code
036     */
037    String getCountryCode();
038
039    /**
040     * This the postal state code for the PostalCode.  This can be null.
041     *
042     * @return postal state code
043     */
044    String getStateCode();
045
046    /**
047     * This the postal state code for the PostalCode.  This can be null.
048     *
049     * @return postal state code
050     */
051    String getCityName();
052
053    /**
054     * This the county code for the PostalCode.  This cannot be null.
055     *
056     * @return postal state code
057     */
058    String getCountyCode();
059}