org.kuali.coeus.common.api.country

Interface KcCountryService

public interface KcCountryService

Method Summary

Methods

Modifier and Type	Method and Description
CountryContract	getCountry(String code) This method retrieves a country by country code.
CountryContract	getCountryByAlternateCode(String alternateCode) This method retrieves a country by alternate country code.

Method Detail

getCountry

CountryContract getCountry(String code)

This method retrieves a country by country code. If the country is not found null is returned. The country code cannot be blank.

Parameters:

code - the country code. cannot be blank.

Returns:

the country or null if not found.

Throws:

IllegalArgumentException - if the code is blank

getCountryByAlternateCode

CountryContract getCountryByAlternateCode(String alternateCode)

This method retrieves a country by alternate country code. The alternate country code is usually a three digit code. If the country is not found null is returned. The alternate country code cannot be blank.

Parameters:

alternateCode - the alternate country code. cannot be blank.

Returns:

the country or null if not found.

Throws:

IllegalArgumentException - if the alternateCode is blank