com.tomtom.online.sdk.search.api.batch

Interface BatchSearchApi

All Superinterfaces:

com.tomtom.online.sdk.common.rx.RxContext

All Known Implementing Classes:

BatchSearchApiImpl

public interface BatchSearchApi
extends com.tomtom.online.sdk.common.rx.RxContext

Defines the batch search api.

Method Summary

Modifier and Type	Method and Description
Single<BatchSearchResponse>	batchSearch(BatchSearchQuery query) Performs reactive batch search action based on provided query object and returns the result to Observers subscribed to returned Observable.
void	batchSearch(BatchSearchQuery searchQuery, BatchSearchResultListener listener) Performs batch search action based on provided BatchSearchQuery object and returns the result with usage of callback implementation.
void	cancelSearchIfRunning() Cancels the current batch request

Methods inherited from interface com.tomtom.online.sdk.common.rx.RxContext

getResultScheduler, getWorkingScheduler

Method Detail

batchSearch

void batchSearch(BatchSearchQuery searchQuery,
                 BatchSearchResultListener listener)

Performs batch search action based on provided BatchSearchQuery object and returns the result with usage of callback implementation.

Parameters:

searchQuery - The object which contains data necessary to execute search batch action.

listener - The listener which informs the subscriber when search result is available. It contains ServiceResponse object.

cancelSearchIfRunning

void cancelSearchIfRunning()

Cancels the current batch request

batchSearch

Single<BatchSearchResponse> batchSearch(BatchSearchQuery query)

Performs reactive batch search action based on provided query object and returns the result to Observers subscribed to returned Observable.

Parameters:

query - Object which contains data necessary to execute batch search action

Returns:

Search response's Observable object.