public interface IAlongRouteSearchQuery
Modifier and Type | Method and Description |
---|---|
IAlongRouteSearchQuery |
withBrandSet(java.lang.String brandSet)
A comma-separated list of brand names which could be used to restrict the result to Points Of Interest of specific brands.
|
AlongRouteSearchQueryBuilder |
withCategorySet(java.util.List<java.lang.Long> categorySet)
Restricts the results to the categories of provided POIs.
|
IAlongRouteSearchQuery |
withDetourOffset()
Turns on the calculation of the distance between the start of the route and the starting point
of the detour to a POI.
|
IAlongRouteSearchQuery |
withEVConnectorSetFilter(java.lang.String evConnectorSet)
A comma-separated list of connector types which could be used to restrict the result to Points Of Interest
of type Electric Vehicle Station, supporting specific connector types.
|
IAlongRouteSearchQuery |
withLimit(java.lang.Integer limit)
The upper limit of the number of results.
|
IAlongRouteSearchQuery |
withMapCodes(java.util.Set<MapCodeType> mapCodes)
Enables the return of mapcodes.
|
IAlongRouteSearchQuery |
withOpeningHours(OpeningHoursMode openingHours)
When used includes a list of opening hours for a POI (Points of Interest).
|
IAlongRouteSearchQuery |
withSortBy(SortBy sortBy)
Sorts the returned results by the provided criteria.
|
IAlongRouteSearchQuery |
withSpreadingMode(SpreadingMode spreadingMode)
Enables the spreading of returned results evenly along the route.
|
IAlongRouteSearchQuery |
withTimeZone(TimeZoneType timeZone)
When used includes POIs' time zones.
|
@NonNull IAlongRouteSearchQuery withLimit(java.lang.Integer limit)
limit
- The upper limit of the number of results.@NonNull IAlongRouteSearchQuery withEVConnectorSetFilter(java.lang.String evConnectorSet)
evConnectorSet
- A comma-separated list of connector types.@NonNull IAlongRouteSearchQuery withBrandSet(java.lang.String brandSet)
brandSet
- A comma-separated list of brand names.@NonNull IAlongRouteSearchQuery withDetourOffset()
@NonNull IAlongRouteSearchQuery withSortBy(SortBy sortBy)
sortBy
- The enum indicating the sorting criteria.@NonNull IAlongRouteSearchQuery withSpreadingMode(SpreadingMode spreadingMode)
spreadingMode
- The enum indicating the spreading mode.@NonNull AlongRouteSearchQueryBuilder withCategorySet(java.util.List<java.lang.Long> categorySet)
categorySet
- Restricts the POIs in the Response to those whose id is listed in the categorySet.@NonNull IAlongRouteSearchQuery withOpeningHours(OpeningHoursMode openingHours)
openingHours
- The opening hours scope.@NonNull IAlongRouteSearchQuery withMapCodes(java.util.Set<MapCodeType> mapCodes)
mapCodes
- The enum type indicating supported MapCodes.@NonNull IAlongRouteSearchQuery withTimeZone(TimeZoneType timeZone)
timeZone
- The enum indicating the type of the time zone.