com.tomtom.online.sdk.search.data

Class SearchResponseBuilder

java.lang.Object

com.tomtom.online.sdk.search.data.SearchResponseBuilder

public class SearchResponseBuilder
extends java.lang.Object

Holds the data for the search response which will be retrieved from the Online Search.

Method Summary

Modifier and Type	Method and Description
SearchResponse	build() Gather all data from the SearchResponseBuilder and instantiates the new SearchResponse object.
static SearchResponseBuilder	create() Instantiates the SearchResponseBuilder object.
SearchResponseBuilder	failReason(SearchResponse.SearchException failReason) Exception describing why the request failed.
SearchResponseBuilder	searchQuery(SearchQuery searchQuery) Query used to obtain current SearchResponse.
SearchResponseBuilder	searchResults(java.util.List<SearchResult> searchResults) List of available search result items.
SearchResponseBuilder	status(int status) Search response status, may be one of those: VALID, INVALID.

Methods inherited from class java.lang.Object

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

Method Detail

searchQuery

public SearchResponseBuilder searchQuery(SearchQuery searchQuery)

Query used to obtain current SearchResponse.

searchResults

public SearchResponseBuilder searchResults(java.util.List<SearchResult> searchResults)

List of available search result items. Available only when search response status is VALID.

failReason

public SearchResponseBuilder failReason(SearchResponse.SearchException failReason)

Exception describing why the request failed. Available only when search response status is INVALID.

status

public SearchResponseBuilder status(int status)

Search response status, may be one of those: VALID, INVALID.

create

public static SearchResponseBuilder create()

Instantiates the SearchResponseBuilder object.

build

public SearchResponse build()

Gather all data from the SearchResponseBuilder and instantiates the new SearchResponse object.