Package org.kuali.rice.location.api.postalcode

Interface PostalCodeContract

All Superinterfaces:
Coded, Inactivatable, Versioned
All Known Implementing Classes:
PostalCode, PostalCode.Builder
public interface PostalCodeContract extends Versioned, Inactivatable, Coded
This is the contract for a Postal Code. A postal code is assigned to different geographic regions in order to give each region an identifier. Examples of postal codes are Zip Codes in the United States and FSALDU in Canada.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Details

    • getCountryCode

      String getCountryCode()
      This the postal country code for the PostalCode. This cannot be null or a blank string.
      Returns:
      postal country code

    • getStateCode

      String getStateCode()
      This the postal state code for the PostalCode. This can be null.
      Returns:
      postal state code

    • getCityName

      String getCityName()
      This the postal state code for the PostalCode. This can be null.
      Returns:
      postal state code

    • getCountyCode

      String getCountyCode()
      This the county code for the PostalCode. This cannot be null.
      Returns:
      postal state code