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

Method Detail

getSuggestions

List<AutoCompleteSuggestion> getSuggestions(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(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

List<String> getProviderNames()
                       throws AttivioException

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

Returns:

list of provider names

Throws:

AttivioException