Package de.hybris.platform.commerceservices.storefinder

Interface StoreFinderService<ITEM extends PointOfServiceDistanceData,RESULT extends StoreFinderSearchPageData<ITEM>>

Type Parameters:

ITEM - distance to point of service

RESULT - search page result

All Known Implementing Classes:

DefaultStoreFinderService

public interface StoreFinderService<ITEM extends PointOfServiceDistanceData,RESULT extends StoreFinderSearchPageData<ITEM>>

Store finder service. It is used for retrieving data for store finder related data.

Method Summary

Modifier and Type	Method	Description
RESULT	getAllPos(BaseStoreModel baseStore, PageableData pageableData)	Gets the locations retrieved basing on the given arguments.
java.util.List<PointOfServiceModel>	getAllPosForCountry(java.lang.String countryIsoCode, BaseStoreModel baseStore)	Gets a list of PointOfServiceModel for all points of service in a given country
java.util.List<PointOfServiceModel>	getAllPosForRegion(java.lang.String countryIsoCode, java.lang.String regionIsoCode, BaseStoreModel baseStore)	Gets a list of PointOfServiceModel for all points of service in a given country and region
ITEM	getPointOfServiceDistanceForName(BaseStoreModel baseStore, java.lang.String name, GeoPoint geoPoint)	Gets the location for the given name that should be unique.
PointOfServiceModel	getPointOfServiceForName(BaseStoreModel baseStore, java.lang.String name)	Gets the PointOfServiceModel for the given name that should be unique
RESULT	locationSearch(BaseStoreModel baseStore, java.lang.String locationText, PageableData pageableData)	Gets the locations retrieved based on the given arguments.
RESULT	locationSearch(BaseStoreModel baseStore, java.lang.String locationText, PageableData pageableData, double maxRadius)	Gets the locations retrieved based on the given arguments.
RESULT	positionSearch(BaseStoreModel baseStore, GeoPoint geoPoint, PageableData pageableData)	Gets the locations retrieved basing on the given arguments.
RESULT	positionSearch(BaseStoreModel baseStore, GeoPoint geoPoint, PageableData pageableData, double maxRadius)	Gets the locations retrieved basing on the given arguments.

Method Detail

locationSearch

RESULT locationSearch(BaseStoreModel baseStore,
                      java.lang.String locationText,
                      PageableData pageableData)

Gets the locations retrieved based on the given arguments.

Parameters:

baseStore - BaseStoreModel instance that returned locations belongs to

locationText - text that will be used for locations search

pageableData - PageableData object that contains basing information for search result set

Returns:

locations found for the given parameters

locationSearch

RESULT locationSearch(BaseStoreModel baseStore,
                      java.lang.String locationText,
                      PageableData pageableData,
                      double maxRadius)

Gets the locations retrieved based on the given arguments.

Parameters:

baseStore - BaseStoreModel instance that returned locations belongs to

locationText - text that will be used for locations search

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

RESULT positionSearch(BaseStoreModel baseStore,
                      GeoPoint geoPoint,
                      PageableData pageableData)

Gets the locations retrieved basing on the given arguments.

Parameters:

baseStore - BaseStoreModel instance that returned locations belongs to

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

RESULT positionSearch(BaseStoreModel baseStore,
                      GeoPoint geoPoint,
                      PageableData pageableData,
                      double maxRadius)

Gets the locations retrieved basing on the given arguments.

Parameters:

baseStore - BaseStoreModel instance that returned locations belongs to

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

PointOfServiceModel getPointOfServiceForName(BaseStoreModel baseStore,
                                             java.lang.String name)

Gets the PointOfServiceModel for the given name that should be unique

Parameters:

baseStore - BaseStoreModel instance that returned location belongs to

name - the requested point of service name

Returns:

PointOfServiceModel for the given parameter

getPointOfServiceDistanceForName

ITEM getPointOfServiceDistanceForName(BaseStoreModel baseStore,
                                      java.lang.String name,
                                      GeoPoint geoPoint)

Gets the location for the given name that should be unique. Additionally the distance between the location and given coordinates is calculated.

Parameters:

baseStore - BaseStoreModel instance that returned location belongs to

name - name of the requested point of service

geoPoint - geographical point of the origin point

Returns:

location for the given parameter

getAllPos

RESULT getAllPos(BaseStoreModel baseStore,
                 PageableData pageableData)

Gets the locations retrieved basing on the given arguments.

Parameters:

baseStore - BaseStoreModel instance that returned locations belongs to

pageableData - PageableData object that contains basing information for search result set

Returns:

locations found for the given parameters

getAllPosForCountry

java.util.List<PointOfServiceModel> getAllPosForCountry(java.lang.String countryIsoCode,
                                                        BaseStoreModel baseStore)

Gets a list of PointOfServiceModel for all points of service in a given country

Parameters:

countryIsoCode - {@link CountryModel:ISOCODE}

baseStore - the active BaseStoreModel

Returns:

list of PointOfServiceModel

getAllPosForRegion

java.util.List<PointOfServiceModel> getAllPosForRegion(java.lang.String countryIsoCode,
                                                       java.lang.String regionIsoCode,
                                                       BaseStoreModel baseStore)

Gets a list of PointOfServiceModel for all points of service in a given country and region

Parameters:

countryIsoCode - {@link CountryModel:ISOCODE}

regionIsoCode - {@link RegionModel:ISOCODE}

baseStore - the active BaseStoreModel

Returns:

list of PointOfServiceModel