Package com.attivio.sdk.client

Interface AutoCompleteApi

All Superinterfaces:

ExposedApi

All Known Implementing Classes:

MockAutoCompleteApi

public interface AutoCompleteApi
extends ExposedApi

API for the retrieving of query completion suggestions based on a current query request.

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getProviderNames()	Get a list of all the autocomplete provider names registered in Attivio
java.util.List<AutoCompleteSuggestion>	getSuggestions(java.lang.String providerName, QueryRequest req)	Get all suggestions from a certain autocomplete provider given its name and a query request
void	resourceModified(java.lang.String uri)	Notifies all autocomplete providers that share resources that their resource has been modified.

Method Detail

getSuggestions

java.util.List<AutoCompleteSuggestion> getSuggestions(java.lang.String providerName,
                                                      QueryRequest req)
                                               throws AttivioException

Get all suggestions from a certain autocomplete provider given its name and a query request

Parameters:

providerName - name of autocomplete provider to use

req - query request

Returns:

list of suggestions for completion

Throws:

AttivioException

resourceModified

void resourceModified(java.lang.String uri)
               throws AttivioException

Notifies all autocomplete providers that share resources that their resource has been modified.

Parameters:

uri - resource as a uri string

Throws:

AttivioException

getProviderNames

java.util.List<java.lang.String> getProviderNames()
                                           throws AttivioException

Get a list of all the autocomplete provider names registered in Attivio

Returns:

list of provider names

Throws:

AttivioException