de.hybris.platform.storelocator.location

Interface LocationMapService

All Known Implementing Classes:

DefaultLocationMapService

public interface LocationMapService

Main purpose of this service's is to provide Map objects for Location objects depending on given parameters such as postal code, country code, town name or GPS coordinates.

See Also:

getMapOfLocations(java.lang.String, java.lang.String, int, de.hybris.platform.store.BaseStoreModel), getMapOfLocationsForTown(java.lang.String, int, de.hybris.platform.store.BaseStoreModel), getMapOfLocationsForPostcode(java.lang.String, java.lang.String, int, de.hybris.platform.store.BaseStoreModel)

Method Summary

Modifier and Type	Method and Description
Map	getMapOfLocations(GPS gps, int limitLocationsCount, BaseStoreModel baseStore) Calculating Map, basing on number of points of interest defined by user and proper radius.
Map	getMapOfLocations(java.lang.String searchTerm, java.lang.String countryCode, int limitLocationsCount, BaseStoreModel baseStore) Method looks for nearby locations for given postal code or town name and creates Map object with found data.
Map	getMapOfLocationsForPostcode(java.lang.String postalCode, java.lang.String countryCode, int limitLocationsCount, BaseStoreModel baseStore) Method looks for nearest locations (points of interest) to the place defined by postal code and country, and creates Map object with given data.
Map	getMapOfLocationsForTown(java.lang.String town, int limitLocationsCount, BaseStoreModel baseStore) Method looks for nearest locations (points of interest) to the place defined by city name, and creates Map object with given data.

Method Detail

getMapOfLocations

Map getMapOfLocations(java.lang.String searchTerm,
                      java.lang.String countryCode,
                      int limitLocationsCount,
                      BaseStoreModel baseStore)

Method looks for nearby locations for given postal code or town name and creates Map object with found data.

Parameters:

searchTerm - the search term - can be postal code or town name

countryCode - the country code - country code to look for (valid if given value is postal code)

limitLocationsCount - number of locations to return

baseStore - if set, method will return locations bound to the given BaseStoreModel

Returns:

map object with found locations

Throws:

LocationMapServiceException

getMapOfLocationsForPostcode

Map getMapOfLocationsForPostcode(java.lang.String postalCode,
                                 java.lang.String countryCode,
                                 int limitLocationsCount,
                                 BaseStoreModel baseStore)

Method looks for nearest locations (points of interest) to the place defined by postal code and country, and creates Map object with given data. Number of returned locations is adequate to user definition. Use when map representation is required.

Parameters:

postalCode - searching condition for locations - postal code

countryCode - searching condition for locations - country code

limitLocationsCount - number of locations to return

baseStore - if set, method will return locations bound to the given BaseStoreModel

Returns:

map object with found locations

Throws:

LocationMapServiceException

getMapOfLocationsForTown

Map getMapOfLocationsForTown(java.lang.String town,
                             int limitLocationsCount,
                             BaseStoreModel baseStore)

Method looks for nearest locations (points of interest) to the place defined by city name, and creates Map object with given data. Number of returned locations is adequate to user definition. Use when map representation is required.

Parameters:

town - searching condition for locations

limitLocationsCount - number of locations to return

baseStore - if set, method will return locations bound to the given BaseStoreModel

Returns:

map object with found locations

Throws:

LocationMapServiceException

getMapOfLocations

Map getMapOfLocations(GPS gps,
                      int limitLocationsCount,
                      BaseStoreModel baseStore)

Calculating Map, basing on number of points of interest defined by user and proper radius.

Parameters:

gps - coordinates of center point

limitLocationsCount - number of places to find, defined by user

baseStore - if set, method will return locations bound to the given BaseStoreModel

Returns:

map from store locator map service

Throws:

LocationMapServiceException

MapServiceException