com.tomtom.online.sdk.search.data.alongroute

Interface IAlongRouteSearchQuery

public interface IAlongRouteSearchQuery

AlongRouteSearchQuery is an interface designed to transfer Search API parameters in a readable manner by implementing the class: AlongRouteSearchQueryBuilder.
The AlongRouteSearchQuery instance can be constructed using the associated AlongRouteSearchQueryBuilder class. Once constructed, the user cannot change the field values.

Method Summary

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.
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.

Method Detail

withLimit

@NonNull
IAlongRouteSearchQuery withLimit(java.lang.Integer limit)

The upper limit of the number of results.

Parameters:

limit - The upper limit of the number of results.

Returns:

The builder of the query with a new value for the limit set.

withEVConnectorSetFilter

@NonNull
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.

Parameters:

evConnectorSet - A comma-separated list of connector types.

Returns:

The builder of the query with a new value for evConnectorSet.

withBrandSet

@NonNull
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.

Parameters:

brandSet - A comma-separated list of brand names.

Returns:

The builder of the query with a new value for brand set set.