IFuzzySearchQuery (Android Search SDK

```
public interface IFuzzySearchQuery
```
This query is an interface designed to transfer Search API parameters in a readable manner by implementing the class: FuzzySearchQueryBuilder.
The FuzzySearchQuery instance can be constructed using the associated FuzzySearchQueryBuilder class. Once constructed, the user cannot change the field values.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IFuzzySearchQuery`	`withBoundingBox(com.tomtom.online.sdk.common.location.BoundingBox boundingBox)` The bounding box for the search.
`IFuzzySearchQuery`	`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.
`IFuzzySearchQuery`	`withCategory(java.lang.Boolean isCategory)` If your search use case only requires POI results filtered by category, you may use the Category endpoint.
`IFuzzySearchQuery`	`withCountry(java.lang.String country)` A comma-separated string of country codes (e.g., FR,ES).
`IFuzzySearchQuery`	`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.
`IFuzzySearchQuery`	`withExtendedPostalCodes(java.lang.String extPostalCodesFor)` Indexes for which extended postal codes should be included in the results.
`IFuzzySearchQuery`	`withIdx(java.lang.String idxSet)` A comma-separated list of indexes which should be utilized for the search.
`IFuzzySearchQuery`	`withLanguage(java.lang.String language)` The language in which search results should be returned.
`IFuzzySearchQuery`	`withLimit(java.lang.Integer limit)` The upper limit of the number of results.
`IFuzzySearchQuery`	`withMaxFuzzyLevel(java.lang.Integer maxFuzzyLevel)` The maximum fuzzyness level to be used.
`IFuzzySearchQuery`	`withMinFuzzyLevel(java.lang.Integer minFuzzyLevel)` The minimum fuzzyness level to be used.
`IFuzzySearchQuery`	`withOffset(java.lang.Integer offset)` The starting offset of the returned results within the full result set.
`IFuzzySearchQuery`	`withPosition(LatLng position)` The position where results should be biased.
`IFuzzySearchQuery`	`withPreciseness(com.tomtom.online.sdk.common.location.LatLngAcc positionAcc)` The position where results should be biased.
`IFuzzySearchQuery`	`withTypeAhead(java.lang.Boolean isTypeAhead)` If the "typeahead" flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.

- Method Detail
  - withLimit
```
@NonNull
IFuzzySearchQuery 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.
  - withOffset
```
@NonNull
IFuzzySearchQuery withOffset(java.lang.Integer offset)
```
    The starting offset of the returned results within the full result set.
    
    Parameters:
    
    offset - The starting offset of the returned results within the full result set.
    
    Returns:
    
    The builder of the query with a new value for the offset being set.
  - withPosition
```
@NonNull
IFuzzySearchQuery withPosition(LatLng position)
```
    The position where results should be biased. Supplying the position without a radius will only bias the search results to that area.
    
    Parameters:
    
    position - The position where results should be biased.
    
    Returns:
    
    The builder of the query with a new value for the position being set.
  - withPreciseness
```
@NonNull
IFuzzySearchQuery withPreciseness(com.tomtom.online.sdk.common.location.LatLngAcc positionAcc)
```
    The position where results should be biased. The radius parameter is specified in meters. If radius and position are set, the results will be constrained to the defined area. If radius is not present, or is set to 0, the results will not be constrained.
    
    Parameters:
    
    positionAcc - The position where results should be biased. Position with accuracy is in meters.
    
    Returns:
    
    The builder of the query with new values for the position and radius being set.
  - withCountry
```
@NonNull
IFuzzySearchQuery withCountry(java.lang.String country)
```
    A comma-separated string of country codes (e.g., FR,ES). This will limit the search to the specified countries.
    
    Parameters:
    
    The - country string with country codes.
    
    Returns:
    
    The builder of the query with a new value for the country being set.
  - withIdx
```
@NonNull
IFuzzySearchQuery withIdx(java.lang.String idxSet)
```
    A comma-separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: Addr, Geo, PAD, POI, Str, Xstr, i.e., "PAD,Addr".
    
    Parameters:
    
    idxSet - The indexes to be utilized for the search.
    
    Returns:
    
    The builder of the query with a new value for the idxSet being set.
  - withBoundingBox
```
@NonNull
IFuzzySearchQuery withBoundingBox(com.tomtom.online.sdk.common.location.BoundingBox boundingBox)
```
    The bounding box for the search. NOTE: Point-Radius parameters and bounding box parameters are mutually exclusive. Point-Radius parameters take precendence when both are passed in.
    
    Parameters:
    
    boundingBox - The top-left position of the bounding box and bottom-right position of the bounding box.
    
    Returns:
    
    The builder of the query with a new value for the bounding box being set.
  - withTypeAhead
```
@NonNull
IFuzzySearchQuery withTypeAhead(java.lang.Boolean isTypeAhead)
```
    If the "typeahead" flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.
    
    Parameters:
    
    isTypeAhead - Determines whether the predictive mode is enabled.
    
    Returns:
    
    The builder of the query with a new value for isTypeAhead being set.
  - withCategory
```
@NonNull
IFuzzySearchQuery withCategory(java.lang.Boolean isCategory)
```
    If your search use case only requires POI results filtered by category, you may use the Category endpoint.
    
    Parameters:
    
    isCategory - Determines whether the Category Search is enabled.
    
    Returns:
    
    The builder of the query with a new value for isCategory being set.
  - withBrandSet
```
@NonNull
IFuzzySearchQuery 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 the brand set being set.
  - withLanguage
```
@NonNull
IFuzzySearchQuery withLanguage(java.lang.String language)
```
    The language in which search results should be returned. Should be one of the supported IETF language tags, case insensitive. When data in the specified language is not available for a specific field, the default langauge is used.
    
    Parameters:
    
    language - The language in which search results should be returned.
    
    Returns:
    
    The builder of the query with a new value for the language being set.
  - withEVConnectorSetFilter
```
@NonNull
IFuzzySearchQuery 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 the evConnectorSet.
  - withExtendedPostalCodes
```
@NonNull
IFuzzySearchQuery withExtendedPostalCodes(java.lang.String extPostalCodesFor)
```
    Indexes for which extended postal codes should be included in the results. Available indexes are: Addr, Geo, PAD, POI, Str, XStr. The value should be a comma-separated list of index types (in any order), or "None" for no indexes, i.e., "PAD,Addr,POI"
    
    Parameters:
    
    extPostalCodesFor - The string with postal codes.
    
    Returns:
    
    The builder of the query with a new value for postal codes.
  - withMinFuzzyLevel
```
@NonNull
IFuzzySearchQuery withMinFuzzyLevel(java.lang.Integer minFuzzyLevel)
```
    The minimum fuzzyness level to be used. The default value is 1. The maximum value is 4.
    
    Parameters:
    
    minFuzzyLevel - The minimum fuzzyness level to be used.
    
    Returns:
    
    The builder of the query with a new value for the minFuzzyLevel being set.
  - withMaxFuzzyLevel
```
@NonNull
IFuzzySearchQuery withMaxFuzzyLevel(java.lang.Integer maxFuzzyLevel)
```
    The maximum fuzzyness level to be used. The default value is 2. The maximum value is 4.
    
    Parameters:
    
    maxFuzzyLevel - The maximum fuzzyness level to be used.
    
    Returns:
    
    The builder of the query with a new value for the maxFuzzyLevel being set.

Interface IFuzzySearchQuery

Method Summary

Method Detail

withLimit

withOffset

withPosition

withPreciseness

withCountry

withIdx

withBoundingBox

withTypeAhead

withCategory

withBrandSet

withLanguage

withEVConnectorSetFilter

withExtendedPostalCodes

withMinFuzzyLevel

withMaxFuzzyLevel