org.kuali.rice.kns.service
Interface PostalCodeService

All Known Implementing Classes:

PostalCodeServiceImpl

public interface PostalCodeService

Method Summary

PostalCode	getByPostalCodeInDefaultCountry(String postalCode) get the postal code object based on the given postal code and default country code.
PostalCode	getByPostalCodeInDefaultCountryIfNecessary(String postalCode, PostalCode existingPostalCode) get the postal code obpostalt based on the given postal code and default country code.
PostalCode	getByPrimaryId(String postalCountryCode, String postalCode) get the postal zip code object based on the given postal code and country code
PostalCode	getByPrimaryIdIfNecessary(String postalCountryCode, String postalCode, PostalCode existingPostalCode) get the postal code object based on the given postal code and country code.

Method Detail

getByPostalCodeInDefaultCountry

PostalCode getByPostalCodeInDefaultCountry(String postalCode)

get the postal code object based on the given postal code and default country code. The default country code is set up in the system.

Parameters:

postalCode - the given postal code

Returns:

the postal code object with the given postal code and default country code.

getByPrimaryId

PostalCode getByPrimaryId(String postalCountryCode,
                          String postalCode)

get the postal zip code object based on the given postal code and country code

Parameters:

postalCountryCode - the given country code

postalCode - the given postal code

Returns:

the postal code object with the given postal code and country code.

getByPostalCodeInDefaultCountryIfNecessary

PostalCode getByPostalCodeInDefaultCountryIfNecessary(String postalCode,
                                                      PostalCode existingPostalCode)

get the postal code obpostalt based on the given postal code and default country code. The default country code is set up in the system. If the given postal postale is same as that of the given existing postal code, return the existing postal code; otherwise, retrieve a postal code object.

Parameters:

postalCode - the given postal code

existingPostalCode - the given existing postal code

Returns:

the postal code object with the given postal code and default country code if necessary

getByPrimaryIdIfNecessary

PostalCode getByPrimaryIdIfNecessary(String postalCountryCode,
                                     String postalCode,
                                     PostalCode existingPostalCode)

get the postal code object based on the given postal code and country code. If the given postal code and country code are same as those of the given existing postal code, return the existing postal code; otherwise, retrieve a postal code object.

Parameters:

postalCountryCode - the given country code

postalCode - the given postal code

existingPostalCode - the given existing postal code

Returns:

the postal code object with the given postal code and country code if necessary