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

Class AlongRouteSearchResponse

java.lang.Object

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

All Implemented Interfaces:

com.tomtom.online.sdk.common.service.ServiceResponse, java.io.Serializable

public class AlongRouteSearchResponse
extends java.lang.Object
implements java.io.Serializable, com.tomtom.online.sdk.common.service.ServiceResponse

Response to Along Route Search request. Consists of a summary and results.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ResponseError	error Error code and description.
protected AlongRouteSearchResult[]	results A portion of results of the request, as specified in the summary by total number of results, number of results and offset.
protected Summary	summary The summary of the response.

Fields inherited from interface com.tomtom.online.sdk.common.service.ServiceResponse

HTTP_OK_CODE

Constructor Summary

Constructors

Constructor and Description
AlongRouteSearchResponse()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getErrorMessage() The error message if applicable.
ImmutableList<AlongRouteSearchResult>	getResults()
boolean	hasError() True if error occurs, false otherwise.

Methods inherited from class java.lang.Object

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

Field Detail

summary

protected Summary summary

The summary of the response.

results

protected AlongRouteSearchResult[] results

A portion of results of the request, as specified in the summary by total number of results, number of results and offset. -- GETTER --

error

protected ResponseError error

Error code and description. -- GETTER --

Constructor Detail

AlongRouteSearchResponse

public AlongRouteSearchResponse()

Method Detail

getResults

public ImmutableList<AlongRouteSearchResult> getResults()

Returns:

the summary of the response.

hasError

public boolean hasError()

True if error occurs, false otherwise.

Specified by:

hasError in interface com.tomtom.online.sdk.common.service.ServiceResponse

getErrorMessage

public java.lang.String getErrorMessage()

The error message if applicable.

Specified by:

getErrorMessage in interface com.tomtom.online.sdk.common.service.ServiceResponse

Returns:

The error message