com.elasticpath.domain.shipping
Interface Country

All Known Implementing Classes:
CountryImpl

public interface Country

Represents a configured country, including its ISO country code, country names (in different language [TBD]), and the subcountries code/label map.


Method Summary
 java.lang.String getCountryCode()
          Return the ISO country code for this Country.
 java.lang.String getCountryName()
          Return the country name (in English).
 java.util.Map getSubCountries()
          Returns a map of subcountries codes and their labels.
 void setCountryCode(java.lang.String countryCode)
          Set the ISO country code for this Country.
 void setCountryName(java.lang.String countryName)
          Set the country name (in English).
 void setSubCountries(java.util.Map subCountries)
          Returns a map of subcountries codes and their labels.
 

Method Detail

getCountryCode

java.lang.String getCountryCode()
Return the ISO country code for this Country.

Returns:
the ISO country code.

getCountryName

java.lang.String getCountryName()
Return the country name (in English).

Returns:
the country name (in English).

getSubCountries

java.util.Map getSubCountries()
Returns a map of subcountries codes and their labels. Subcountries are any region of a country such as a province, state, or territory. Note that this method assumes the country information does not change at runtime.

Returns:
a map of codes to labels of subcountries for this country.

setCountryCode

void setCountryCode(java.lang.String countryCode)
Set the ISO country code for this Country.

Parameters:
countryCode - - the ISO country code.

setCountryName

void setCountryName(java.lang.String countryName)
Set the country name (in English).

Parameters:
countryName - - the country name (in English).

setSubCountries

void setSubCountries(java.util.Map subCountries)
Returns a map of subcountries codes and their labels. Subcountries are any region of a country such as a province, state, or territory. Note that this method assumes the country information does not change at runtime.

Parameters:
subCountries - a map of codes to labels of subcountries for this country.