de.hybris.platform.storelocator.location

Interface LocationService<T extends Location>

All Known Subinterfaces:

DistanceAwareLocationService<T>

All Known Implementing Classes:

DefaultLocationService

public interface LocationService<T extends Location>

Handles CRUD operations of Location. It is able to return Locations in the proximity of the given GPS that are sorted in terms of distances.

Method Summary

Modifier and Type	Method and Description
boolean	deleteLocation(T location) Delete the given IAddress from the collection of stored addresses
T	getLocation(String streetName, String streetNumber, String postalCode, String town, String countryCode, boolean geocode) Get temporary, non-persisted location
T	getLocationByName(String name) Returns persisted Location by name
List<T>	getLocationsForPoint(GPS gps, int limitLocationsCount, BaseStoreModel baseStore) Method returns the nearest locations (points of interest) to the given coordinates, in the number adequate to user definition.
List<T>	getLocationsForPostcode(String postalCode, String countryCode, int limitLocationsCount, BaseStoreModel baseStore) Method looks for nearest locations (points of interest) to the place defined by postal code and country.
List<T>	getLocationsForSearch(String searchTerm, String countryCode, int limitLocationsCount, BaseStoreModel baseStore) Method looks for nearby locations (points of interest) in the place defined by search term (that can be postal code or town name) and country.
List<T>	getLocationsForTown(String town, int limitLocationsCount, BaseStoreModel baseStore) Method looks for nearest locations (points of interest) to the place defined by city name.
List<T>	getLocationsNearby(GPS gps, double distance) Get all known addresses which are located in the circle centered in the given gps location and a given radius
List<T>	getLocationsNearby(GPS gps, double distance, BaseStoreModel baseStore) Get all known addresses which are located in the circle centered in the given gps location and a given radius, which belong to a given store
List<T>	getSortedLocationsNearby(GPS gps, double distance, BaseStoreModel baseStore) Returns list of sorted DistanceAwareLocations.
boolean	saveOrUpdateLocation(T location) Adds a new address or update existing one

Method Detail

getLocationsNearby

List<T> getLocationsNearby(GPS gps,
                           double distance)
                    throws LocationServiceException

Get all known addresses which are located in the circle centered in the given gps location and a given radius

Parameters:

gps -

distance - in kilometers

Returns:

List of addresses

Throws:

LocationServiceException

getLocationsNearby

List<T> getLocationsNearby(GPS gps,
                           double distance,
                           BaseStoreModel baseStore)
                    throws LocationServiceException

Get all known addresses which are located in the circle centered in the given gps location and a given radius, which belong to a given store

Parameters:

gps -

distance - in kilometers

baseStore -

Returns:

List of addresses

Throws:

LocationServiceException

saveOrUpdateLocation

boolean saveOrUpdateLocation(T location)
                      throws LocationServiceException

Adds a new address or update existing one

Parameters:

location -

Returns:

true if operation was successful

Throws:

LocationServiceException

deleteLocation

boolean deleteLocation(T location)
                throws LocationServiceException

Delete the given IAddress from the collection of stored addresses

Parameters:

location -

Returns:

true if address was deleted

Throws:

LocationServiceException

getLocationByName

T getLocationByName(String name)
             throws LocationServiceException

Returns persisted Location by name

Parameters:

name -

Returns:

Location matched by unique name

Throws:

LocationServiceException

getLocation

T getLocation(String streetName,
              String streetNumber,
              String postalCode,
              String town,
              String countryCode,
              boolean geocode)
       throws LocationServiceException

Get temporary, non-persisted location

Parameters:

streetName -

streetNumber -

postalCode -

town -

countryCode -

geocode - - set to true if return Location should have GPS data populated

Returns:

Location

Throws:

LocationServiceException

getLocationsForPoint

List<T> getLocationsForPoint(GPS gps,
                             int limitLocationsCount,
                             BaseStoreModel baseStore)
                      throws LocationServiceException

Method returns the nearest locations (points of interest) to the given coordinates, in the number adequate to user definition. Use when you have got defined coordinates and need only sorted locations nearby, without any map.

Parameters:

gps - coordinates of center point

limitLocationsCount - number of POIs chosen by user

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

Returns:

list of proper Locations

Throws:

LocationServiceException

getLocationsForSearch

List<T> getLocationsForSearch(String searchTerm,
                              String countryCode,
                              int limitLocationsCount,
                              BaseStoreModel baseStore)
                       throws LocationServiceException

Method looks for nearby locations (points of interest) in the place defined by search term (that can be postal code or town name) and country. Basically it combines two other methods that retrieves locations for town name and postal code.

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:

list of found locations

Throws:

LocationServiceException

getLocationsForPostcode

List<T> getLocationsForPostcode(String postalCode,
                                String countryCode,
                                int limitLocationsCount,
                                BaseStoreModel baseStore)
                         throws LocationServiceException

Method looks for nearest locations (points of interest) to the place defined by postal code and country. Number of returned locations is adequate to user definition. Use when you don't need any map, only list of sorted locations is enough.

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:

list of found locations

Throws:

LocationServiceException

getLocationsForTown

List<T> getLocationsForTown(String town,
                            int limitLocationsCount,
                            BaseStoreModel baseStore)
                     throws LocationServiceException

Method looks for nearest locations (points of interest) to the place defined by city name. Number of returned locations is adequate to user definition. Use when you don't need any map, only list of sorted locations is enough.

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:

list of found locations

Throws:

LocationServiceException

getSortedLocationsNearby

List<T> getSortedLocationsNearby(GPS gps,
                                 double distance,
                                 BaseStoreModel baseStore)
                          throws LocationServiceException

Returns list of sorted DistanceAwareLocations. Sorting order is ascending - the closest locations come first.

Parameters:

gps - - reference location. Center.

distance - - radius in [km]. The returned locations are contained in the square that the circle describes.

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

Throws:

LocationServiceException