org.kuali.rice.shareddata.api.postalcode
Interface PostalCodeContract

All Known Implementing Classes:

PostalCode, PostalCode.Builder, PostalCodeBo, PostalCodeEbo

public interface PostalCodeContract

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.

Method Summary

String	getCityName() This the postal state code for the PostalCode.
String	getCode() This the county 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.
Long	getVersionNumber() This the object version number for PostalCode.
boolean	isActive() This the active flag for the PostalCode.

Method Detail

getCode

String getCode()

This the county code for the PostalCode. This cannot be null or a blank string.

Returns:

code

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

isActive

boolean isActive()

This the active flag for the PostalCode.

Returns:

the active flag of the PostalCode

getVersionNumber

Long getVersionNumber()

This the object version number for PostalCode.

Returns:

the version number of the PostalCode