com.tomtom.online.sdk.search.data.batch

Class BatchSearchResponse

java.lang.Object

com.tomtom.online.sdk.search.data.batch.BatchSearchResponse

All Implemented Interfaces:

SearchResponse

public class BatchSearchResponse
extends java.lang.Object
implements SearchResponse

Field Summary

Fields

Modifier and Type	Field and Description
protected ResponseError	error
protected BatchableSearchResponse[]	responses
protected int	successfulRequests
protected int	totalRequests

Constructor Summary

Constructors

Constructor and Description
BatchSearchResponse()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getErrorMessage() The error message, as returned by the server.
java.util.List<FuzzySearchResponse>	getFuzzySearchResponses() Get a list of fuzzy search results of a Batch search query.
java.util.List<GeometrySearchResponse>	getGeometrySearchResponses() Get a list of geometry search results of a Batch search query.
java.util.List<ReverseGeocoderSearchResponse>	getReverseGeocoderSearchResponses() Get a list of reverse geocoding search results of a Batch search query.
ImmutableList<BatchableSearchResponse>	getSearchResponses() Get a list of results of a Batch Search query.
boolean	hasError() True if an error occurred, false otherwise.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

error

protected ResponseError error

totalRequests

protected int totalRequests

successfulRequests

protected int successfulRequests

responses

protected BatchableSearchResponse[] responses

Constructor Detail

BatchSearchResponse

public BatchSearchResponse()

Method Detail

hasError

public boolean hasError()

Description copied from interface: SearchResponse

True if an error occurred, false otherwise.

Specified by:

hasError in interface SearchResponse

Returns:

true if an error occurred, false otherwise

getErrorMessage

public java.lang.String getErrorMessage()

Description copied from interface: SearchResponse

The error message, as returned by the server. Only defined in case of an error.

Specified by:

getErrorMessage in interface SearchResponse

Returns:

the error message

getSearchResponses

public ImmutableList<BatchableSearchResponse> getSearchResponses()

Get a list of results of a Batch Search query. For each item, use BatchableSearchResponseVisitor to obtain the specific response type.

getFuzzySearchResponses

public java.util.List<FuzzySearchResponse> getFuzzySearchResponses()

Get a list of fuzzy search results of a Batch search query. This list will be empty if there were no requests of this type.

getGeometrySearchResponses

public java.util.List<GeometrySearchResponse> getGeometrySearchResponses()

Get a list of geometry search results of a Batch search query. This list will be empty if there were no requests of this type.

getReverseGeocoderSearchResponses

public java.util.List<ReverseGeocoderSearchResponse> getReverseGeocoderSearchResponses()

Get a list of reverse geocoding search results of a Batch search query. This list will be empty if there were no requests of this type.