com.sdl.delivery.iq.query.api

Interface QueryClient

All Known Implementing Classes:

RestQueryClient

public interface QueryClient

QueryClient.

Interface acting as the communication performing entry point to the Query Service.

Method Summary

Modifier and Type	Method and Description
void	registerQueryTransformer(Class<? extends QueryResultData> resultDataClass, Class<? extends QueryResult> resultClass, String transformerName) Registers the query transformer for given type tokens.
<T extends QueryResultData<R>,R extends QueryResult> T	searchById(String index, String id, Class<T> resultSetClass, Class<R> resultClass) Searches a document by Id.
<T extends QueryResultData<R>,R extends QueryResult> T	searchWithCriteria(String index, String criteria, Class<T> resultSetClass, Class<R> resultClass, ResultFilter filter) Searches for documents by the specified criteria.
void	shutdown() Closes any resources hold by client.

Method Detail

searchById

<T extends QueryResultData<R>,R extends QueryResult> T searchById(String index,
                                                                  String id,
                                                                  Class<T> resultSetClass,
                                                                  Class<R> resultClass)
                                                           throws QueryException

Searches a document by Id.

Parameters:

index - the search index name.

id - the id.

Returns:

Service response data with query results.

Throws:

QueryException

searchWithCriteria

<T extends QueryResultData<R>,R extends QueryResult> T searchWithCriteria(String index,
                                                                          String criteria,
                                                                          Class<T> resultSetClass,
                                                                          Class<R> resultClass,
                                                                          ResultFilter filter)
                                                                   throws QueryException

Searches for documents by the specified criteria.

Parameters:

index - the search index name.

criteria - the criteria.

filter - The result filter

Returns:

Service response data with query results.

Throws:

QueryException

registerQueryTransformer

void registerQueryTransformer(Class<? extends QueryResultData> resultDataClass,
                              Class<? extends QueryResult> resultClass,
                              String transformerName)

Registers the query transformer for given type tokens.

shutdown

void shutdown()

Closes any resources hold by client.