Package de.hybris.platform.commercefacades.storelocator

Interface StoreLocatorFacade

All Known Implementing Classes:

DefaultStoreLocatorFacade

public interface StoreLocatorFacade

Store locator facade. Contains methods related to store locator functionality - finding points of services, sorting them by distance, retrieving details.

Method Summary

Modifier and Type	Method	Description
Map	getLocationsForQuery(java.lang.String searchTerm, int limit)	Gets the locations for query.
PointOfServiceData	getPOSForLocation(Location location)	Gets the point of service for the given location.
PointOfServiceData	getPOSForName(java.lang.String posName)	Gets the point of service for name that is unique.

Method Detail

getLocationsForQuery

Map getLocationsForQuery(java.lang.String searchTerm,
                         int limit)
                  throws MapServiceException

Gets the locations for query. Returns locations for the given query string that can be postal code or town name. Locations number is limited to the given value.

Parameters:

searchTerm - the search term to look locations for. Can be postal code or town name

limit - the maximum number of returned results

Returns:

the map of locations

Throws:

MapServiceException - the map service exception

getPOSForName

PointOfServiceData getPOSForName(java.lang.String posName)
                          throws LocationServiceException

Gets the point of service for name that is unique.

Parameters:

posName - the pos name

Returns:

the found point of service

Throws:

LocationServiceException - if Location for name can not be found

getPOSForLocation

PointOfServiceData getPOSForLocation(Location location)

Gets the point of service for the given location. If location is distance aware also fills information about distance.

Parameters:

location - the location

Returns:

the point of service for location