Package ru.bitel.oss.kernel.directories.address.common.service

Interface AddressService

public interface AddressService

Method Summary

Modifier and Type	Method	Description
List<AddressDirectoryItem>	addressDirectoryList(int mode, int cityId, int areaId, int streetId, int quarterId)	Получение элементов справочника адресов (город, улица, район, квартал, дом).
void	addressEntityDataDelete(AddressEntityType addressEntityType, int recordId)
AddressEntityData	addressEntityDataGet(AddressEntityType addressEntityType, int recordId)
void	addressEntityDataUpdate(AddressEntityData addressEntityData)
List<IdTitle>	addressEntityItems(AddressEntityType addressEntityType, int parentId)
List<ru.bitel.bgbilling.common.model.KeyValue>	addressFormat(EntityAttrAddress attrAddress, EntityType entityType)
int	addressHouseUpdate(House house)	Изменение дома в справочнике адресов с проверкой на дубликаты.
void	addressImport(int mode, int id, String data)
void	areaDelete(int id)
Area	areaGet(int id)
List<Area>	areaList(int cityId)
int	areaUpdate(Area area)
boolean	checkGarPluginInstalled()
void	cityDelete(int id)
City	cityGet(int id)
List<City>	cityList(int countryId)
int	cityUpdate(City city)
void	countryDelete(int id)
Country	countryGet(int id)
int	countryUpdate(Country country)
void	extraParamsUpdate(AddressEntityType addressEntityType, int recordId, List<ru.bitel.bgbilling.common.model.KeyValue> values)
HouseCoordinates	getCoordinatesByHouse(int houseId)
AddressHouseArea	houseAreaGet(int streetId, String houseAndFrac, int house, String frac)	Получение информации о районе и квартале дома.
HouseData	houseDataGet(int id)
void	houseDelete(int id)
AddressHouseEditorData	houseEditorGet(int id, String addressType)	Получение данных для редактора дома в справочнике адресов.
List<AddressHouseFilterItem>	houseFilterList(int cityId, int quarterId, int streetId, String houseFrac)	Получение списка домов, отобранных по городу, кварталу, улице и номеру дома.
House	houseGet(int id)
String	houseIndexGet(int streetId, String houseAndFrac, int house, String frac)
AddressHouseInfo	houseInfoGet(int houseId, int pid, String flat, String room, String pod, String floor, boolean isObject)	Получение информации о доме: сам дом, его дополнительные параметры и варианты форматирования адреса.
List<House>	houseList(int cityId, int areaId, int streetId, int quarterId, int house, String frac, Page page)
int	houseUpdate(House house)
String	postIndexGet(int streetId, String houseAndFrac, int house, String frac)
void	quarterDelete(int id)
Quarter	quarterGet(int id)
List<Quarter>	quarterList(int cityId)
int	quarterUpdate(Quarter quarter)
void	saveCoordinates(HouseCoordinates houseCoordinates)
SearchResult<Area>	searchAreaList(int cityId, String title, String searchMode, Page page)
SearchResult<City>	searchCityList(int countryId, String title, String searchMode, Page page)
HouseCoordinates	searchCoordinatesByHouseId(int houseId)
SearchResult<Country>	searchCountryList(String title, String searchMode, Page page)
SearchResult<House>	searchHouseList(int cityId, int areaId, int quarterId, int streetId, String house, Page page)
SearchResult<Quarter>	searchQuarterList(int cityId, String title, String searchMode, Page page)
SearchResult<Street>	searchStreetList(int cityId, String title, String searchMode, Page page)
void	streetDelete(int id)
Street	streetGet(int id)
List<Street>	streetList(int cityId)
List<Street>	streetSearch(int cityId, String title, String cityTitle, Page page)
List<Street>	streetSearchBySubstring(String substring)	Получение списка улиц, название которых содержит указанную подстроку.
int	streetUpdate(Street street)

Method Details

countryGet

Country countryGet(int id)
            throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

searchCountryList

SearchResult<Country> searchCountryList(String title,
 String searchMode,
 Page page)
                                 throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

countryUpdate

int countryUpdate(Country country)
           throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

countryDelete

void countryDelete(int id)
            throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

cityGet

City cityGet(int id)
      throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

searchCityList

SearchResult<City> searchCityList(int countryId,
 String title,
 String searchMode,
 Page page)
                           throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

cityUpdate

int cityUpdate(City city)
        throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

cityDelete

void cityDelete(int id)
         throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

cityList

List<City> cityList(int countryId)
             throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

areaGet

Area areaGet(int id)
      throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

searchAreaList

SearchResult<Area> searchAreaList(int cityId,
 String title,
 String searchMode,
 Page page)
                           throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

areaUpdate

int areaUpdate(Area area)
        throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

areaDelete

void areaDelete(int id)
         throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

areaList

List<Area> areaList(int cityId)
             throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

streetGet

Street streetGet(int id)
          throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

searchStreetList

SearchResult<Street> searchStreetList(int cityId,
 String title,
 String searchMode,
 Page page)
                               throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

streetSearch

List<Street> streetSearch(int cityId,
 String title,
 String cityTitle,
 Page page)
                   throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

streetUpdate

int streetUpdate(Street street)
          throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

streetDelete

void streetDelete(int id)
           throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

streetList

List<Street> streetList(int cityId)
                 throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

quarterGet

Quarter quarterGet(int id)
            throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

searchQuarterList

SearchResult<Quarter> searchQuarterList(int cityId,
 String title,
 String searchMode,
 Page page)
                                 throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

quarterUpdate

int quarterUpdate(Quarter quarter)
           throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

quarterDelete

void quarterDelete(int id)
            throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

quarterList

List<Quarter> quarterList(int cityId)
                   throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

postIndexGet

String postIndexGet(int streetId,
 String houseAndFrac,
 int house,
 String frac)
             throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

houseGet

House houseGet(int id)
        throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

houseDataGet

HouseData houseDataGet(int id)
                throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

houseList

List<House> houseList(int cityId,
 int areaId,
 int streetId,
 int quarterId,
 int house,
 String frac,
 Page page)
               throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

houseUpdate

int houseUpdate(House house)
         throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

houseDelete

void houseDelete(int id)
          throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

searchHouseList

SearchResult<House> searchHouseList(int cityId,
 int areaId,
 int quarterId,
 int streetId,
 String house,
 Page page)
                             throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

houseFilterList

List<AddressHouseFilterItem> houseFilterList(int cityId,
 int quarterId,
 int streetId,
 String houseFrac)
                                      throws ru.bitel.bgbilling.common.BGException

Получение списка домов, отобранных по городу, кварталу, улице и номеру дома.

Parameters:

cityId - ID города.

quarterId - ID квартала.

streetId - ID улицы.

houseFrac - номер дома с дробью (подстрока, регистр не учитывается).

Returns:

список домов.

Throws:

ru.bitel.bgbilling.common.BGException

addressDirectoryList

List<AddressDirectoryItem> addressDirectoryList(int mode,
 int cityId,
 int areaId,
 int streetId,
 int quarterId)
                                         throws ru.bitel.bgbilling.common.BGException

Получение элементов справочника адресов (город, улица, район, квартал, дом).

Parameters:

mode - код типа элемента справочника (см. AddressEntityType).

cityId - ID города.

areaId - ID района.

streetId - ID улицы.

quarterId - ID квартала.

Returns:

список элементов справочника.

Throws:

ru.bitel.bgbilling.common.BGException

streetSearchBySubstring

List<Street> streetSearchBySubstring(String substring)
                              throws ru.bitel.bgbilling.common.BGException

Получение списка улиц, название которых содержит указанную подстроку.

Parameters:

substring - подстрока названия улицы.

Returns:

список улиц.

Throws:

ru.bitel.bgbilling.common.BGException

houseAreaGet

AddressHouseArea houseAreaGet(int streetId,
 String houseAndFrac,
 int house,
 String frac)
                       throws ru.bitel.bgbilling.common.BGException

Получение информации о районе и квартале дома.

Parameters:

streetId - ID улицы.

houseAndFrac - номер дома с дробью.

house - номер дома.

frac - дробь дома.

Returns:

информация о районе и квартале дома.

Throws:

ru.bitel.bgbilling.common.BGException

houseInfoGet

AddressHouseInfo houseInfoGet(int houseId,
 int pid,
 String flat,
 String room,
 String pod,
 String floor,
 boolean isObject)
                       throws ru.bitel.bgbilling.common.BGException

Получение информации о доме: сам дом, его дополнительные параметры и варианты форматирования адреса.

Parameters:

houseId - ID дома.

pid - ID параметра договора/объекта (для вариантов форматирования адреса).

flat - квартира.

room - комната.

pod - подъезд.

floor - этаж.

isObject - признак того, что параметр принадлежит объекту.

Returns:

информация о доме.

Throws:

ru.bitel.bgbilling.common.BGException

houseEditorGet

AddressHouseEditorData houseEditorGet(int id,
 String addressType)
                               throws ru.bitel.bgbilling.common.BGException

Получение данных для редактора дома в справочнике адресов.

Parameters:

id - ID дома.

addressType - тип адреса (house, street, area, quarter, city, country).

Returns:

данные для редактора дома.

Throws:

ru.bitel.bgbilling.common.BGException

addressHouseUpdate

int addressHouseUpdate(House house)
                throws ru.bitel.bgbilling.common.BGException

Изменение дома в справочнике адресов с проверкой на дубликаты.

Parameters:

house - дом.

Returns:

ID дома.

Throws:

ru.bitel.bgbilling.common.BGException

addressFormat

List<ru.bitel.bgbilling.common.model.KeyValue> addressFormat(EntityAttrAddress attrAddress,
 EntityType entityType)
                                                      throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

houseIndexGet

String houseIndexGet(int streetId,
 String houseAndFrac,
 int house,
 String frac)
              throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

extraParamsUpdate

void extraParamsUpdate(AddressEntityType addressEntityType,
 int recordId,
 List<ru.bitel.bgbilling.common.model.KeyValue> values)
                throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

addressEntityDataGet

AddressEntityData addressEntityDataGet(AddressEntityType addressEntityType,
 int recordId)
                                throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

addressEntityDataUpdate

void addressEntityDataUpdate(AddressEntityData addressEntityData)
                      throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

addressEntityDataDelete

void addressEntityDataDelete(AddressEntityType addressEntityType,
 int recordId)
                      throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

addressEntityItems

List<IdTitle> addressEntityItems(AddressEntityType addressEntityType,
 int parentId)
                          throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

addressImport

void addressImport(int mode,
 int id,
 String data)
            throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

checkGarPluginInstalled

boolean checkGarPluginInstalled()
                         throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

saveCoordinates

void saveCoordinates(HouseCoordinates houseCoordinates)
              throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

getCoordinatesByHouse

HouseCoordinates getCoordinatesByHouse(int houseId)
                                throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException

searchCoordinatesByHouseId

HouseCoordinates searchCoordinatesByHouseId(int houseId)
                                     throws ru.bitel.bgbilling.common.BGException

Throws:

ru.bitel.bgbilling.common.BGException