Package ru.bitel.bgbilling.plugins.fias.common.service

# Interface FiasService

public interface FiasService

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Result<FiasCity>`
  `getRegionCity(String regionId, String cityTitle)`
  Получиь город для региона
  `Result<Region>`
  `getRegions()`
  Возвращает список доступных для загрузки регионов.
  `StartData`
  `getStartData()`
  Получиь данные для старта синхронизации
  `String`
  `loadAllStreet(FiasCity city)`
  Загрузить оставшиеся улицы
  `String`
  `loadRegion(String regionId)`
  Грузит регион
  `Result<FiasStreet>`
  `startSync(String regionId, FiasCity city, boolean newLoad)`
  Начать синхронизацию
  `Result<FiasStreet>`
  `streetSync(int cityId, FiasStreet street)`
  продолжить синхронизацию

- ## Method Details

  - ### getRegions

    Result<Region> getRegions() throws ru.bitel.bgbilling.common.BGMessageException, ru.bitel.bgbilling.common.BGException
    Возвращает список доступных для загрузки регионов.
    Returns:
      - список доступных для загрузки регионов.
    Throws:
      `ru.bitel.bgbilling.common.BGMessageException`
      `ru.bitel.bgbilling.common.BGException`

  - ### loadRegion

    String loadRegion(String regionId) throws ru.bitel.bgbilling.common.BGMessageException, ru.bitel.bgbilling.common.BGException
    Грузит регион
    Parameters:
      `regionId` - - id региона
    Returns:
      - лог загрузки в виде списка строк
    Throws:
      `ru.bitel.bgbilling.common.BGMessageException`
      `ru.bitel.bgbilling.common.BGException`

  - ### getStartData

    StartData getStartData() throws ru.bitel.bgbilling.common.BGMessageException, ru.bitel.bgbilling.common.BGException
    Получиь данные для старта синхронизации
    Throws:
      `ru.bitel.bgbilling.common.BGMessageException`
      `ru.bitel.bgbilling.common.BGException`

  - ### getRegionCity

    Result<FiasCity> getRegionCity(String regionId, String cityTitle) throws ru.bitel.bgbilling.common.BGMessageException, ru.bitel.bgbilling.common.BGException
    Получиь город для региона
    Throws:
      `ru.bitel.bgbilling.common.BGMessageException`
      `ru.bitel.bgbilling.common.BGException`

  - ### streetSync

    Result<FiasStreet> streetSync(int cityId, FiasStreet street) throws ru.bitel.bgbilling.common.BGMessageException, ru.bitel.bgbilling.common.BGException
    продолжить синхронизацию
    Throws:
      `ru.bitel.bgbilling.common.BGMessageException`
      `ru.bitel.bgbilling.common.BGException`

  - ### startSync

    Result<FiasStreet> startSync(String regionId, FiasCity city, boolean newLoad) throws ru.bitel.bgbilling.common.BGMessageException, ru.bitel.bgbilling.common.BGException
    Начать синхронизацию
    Throws:
      `ru.bitel.bgbilling.common.BGMessageException`
      `ru.bitel.bgbilling.common.BGException`

  - ### loadAllStreet

    String loadAllStreet(FiasCity city) throws ru.bitel.bgbilling.common.BGMessageException, ru.bitel.bgbilling.common.BGException
    Загрузить оставшиеся улицы
    Throws:
      `ru.bitel.bgbilling.common.BGMessageException`
      `ru.bitel.bgbilling.common.BGException`