Interface StoreFinderFacade

All Known Implementing Classes:
DefaultStoreFinderFacade

public interface StoreFinderFacade
Store finder facade. It is used for retrieving data for store finder related data.
  • Method Details

    • locationSearch

      StoreFinderSearchPageData<PointOfServiceData> locationSearch(String locationText, PageableData pageableData)
      Gets the search page data object parametrized with PointOfServiceData and contains location search results for the given location text.
      Parameters:
      locationText - the text that location search is performed for
      pageableData - PageableData object that contains basing information for search result set
      Returns:
      locations found for the given parameters
    • locationSearch

      StoreFinderSearchPageData<PointOfServiceData> locationSearch(String locationText, PageableData pageableData, double maxRadius)
      Gets the search page data object parametrized with PointOfServiceData and contains location search results for the given location text.
      Parameters:
      locationText - the text that location search is performed for
      pageableData - PageableData object that contains basing information for search result set
      maxRadius - the maximum radius from the location that results should be returned for.
      Returns:
      locations found for the given parameters
    • positionSearch

      StoreFinderSearchPageData<PointOfServiceData> positionSearch(GeoPoint geoPoint, PageableData pageableData)
      Gets the search page data object parametrized with PointOfServiceData and contains location search results for the given coordinates
      Parameters:
      geoPoint - geographical point that search is performed for
      pageableData - PageableData object that contains basing information for search result set
      Returns:
      locations found for the given parameters
    • positionSearch

      StoreFinderSearchPageData<PointOfServiceData> positionSearch(GeoPoint geoPoint, PageableData pageableData, double maxRadius)
      Gets the search page data object parametrized with PointOfServiceData and contains location search results for the given coordinates
      Parameters:
      geoPoint - geographical point that search is performed for
      pageableData - PageableData object that contains basing information for search result set
      maxRadius - the maximum radius from the location that results should be returned for.
      Returns:
      locations found for the given parameters
    • getPointOfServiceForName

      PointOfServiceData getPointOfServiceForName(String name)
      Gets the PointOfServiceData for the given name that should be unique
      Parameters:
      name - the point of service name
      Returns:
      PointOfServiceData for the given parameter
    • getPointOfServiceForNameAndPosition

      PointOfServiceData getPointOfServiceForNameAndPosition(String name, GeoPoint geoPoint)
      Gets the PointOfServiceData for the given name that should be unique. Additionally the distance between the PointOfServiceData and given coordinates is calculated.
      Parameters:
      name - - name of the requested point of service
      geoPoint - - geographical location of the origin point
      Returns:
      PointOfServiceData for the given parameter
    • getAllPointOfServices

      StoreFinderSearchPageData<PointOfServiceData> getAllPointOfServices(PageableData pageableData)
      Gets the search page data object parametrized with PointOfServiceData and contains all stores for current base store
      Parameters:
      pageableData - PageableData object that contains basing information for search result set
      Returns:
      locations found for the given parameters
    • getStoreCounts

      List<StoreCountData> getStoreCounts()
      Gets the store's counts per country and its regions
      Returns:
      List<StoreCountData>
    • getPointsOfServiceForCountry

      List<PointOfServiceData> getPointsOfServiceForCountry(String countryIsoCode)
      Gets a list of PointOfServiceData for all points of service in a given country
      Parameters:
      countryIsoCode - {@link CountryModel:ISOCODE}
      Returns:
      list of PointOfServiceData
    • getPointsOfServiceForRegion

      List<PointOfServiceData> getPointsOfServiceForRegion(String countryIsoCode, String regionIsoCode)
      Gets a list of PointOfServiceData for all points of service in a given country and region
      Parameters:
      countryIsoCode - {@link CountryModel:ISOCODE}
      regionIsoCode - {@link RegionModel:ISOCODE}
      Returns:
      list of PointOfServiceData