org.kuali.rice.location.api.postalcode

Interface PostalCodeContract

All Superinterfaces:

Coded, Inactivatable, Versioned

All Known Subinterfaces:

PostalCodeEbo

All Known Implementing Classes:

PostalCode, PostalCode.Builder, PostalCodeBo

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 Summary

Methods

Modifier and Type	Method and Description
String	getCityName() This the postal state code for the PostalCode.
String	getCountryCode() This the postal country code for the PostalCode.
String	getCountyCode() This the county code for the PostalCode.
String	getStateCode() This the postal state code for the PostalCode.

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable

isActive

Methods inherited from interface org.kuali.rice.core.api.mo.common.Coded

getCode

Method Detail

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