Interface AddressService

All Superinterfaces:
AddressService
All Known Implementing Classes:
ChineseAddressService

public interface AddressService extends AddressService
Provide methods to handle address related request
  • Method Details

    • getCitiesForRegion

      List<CityModel> getCitiesForRegion(String regionCode)
      Find cities by region code
      Parameters:
      regionCode - region code
      Returns:
      city list in the region
    • getDistrictsForCity

      List<DistrictModel> getDistrictsForCity(String cityCode)
      Find districts by city code
      Parameters:
      cityCode - city code
      Returns:
      district list in the city
    • getCityForIsocode

      CityModel getCityForIsocode(String isocode)
      Find city by its code
      Parameters:
      isocode - city code
      Returns:
      city model
    • getDistrictForIsocode

      DistrictModel getDistrictForIsocode(String isocode)
      Find district by its code
      Parameters:
      isocode - district code
      Returns:
      district model
    • getCityForRegionAndIsocode

      CityModel getCityForRegionAndIsocode(RegionModel region, String isocode)
      Gets city by region and its code
      Parameters:
      region - the region that the city belongs to
      isocode - city code
      Returns:
      city model
    • getDistrictForCityAndIsocode

      DistrictModel getDistrictForCityAndIsocode(CityModel city, String isocode)
      Gets district by city and its code
      Parameters:
      city - the city that the district belongs to
      isocode - district code
      Returns:
      district model