com.hound.android.sdk

Class TextSearch

java.lang.Object

com.hound.android.sdk.TextSearch

@Exposed
public class TextSearch
extends java.lang.Object

Performs a text search to the Hound server given a HoundRequestInfo and query.

Used the TextSearch.Builder to construct a text search object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextSearch.Builder The only way to construct a TextSearch object.
static class	TextSearch.Result The main object returned from search().
static class	TextSearch.TextSearchException

Method Summary

Methods

Modifier and Type	Method and Description
void	abort() Interrupts any ongoing text search.
TextSearch.Result	search() Performs a text search that runs synchronously.

Methods inherited from class java.lang.Object

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

Method Detail

search

@Exposed
public TextSearch.Result search()
                         throws TextSearch.TextSearchException

Performs a text search that runs synchronously.

Returns:

the result which contain both the meta information for the search and the HoundResponse itself.

Throws:

TextSearch.TextSearchException - if any error occurs

abort

@Exposed
public void abort()

Interrupts any ongoing text search. If this is called before or after a text search, the behavior is unknown.