Package modules.commons.search

Interface SearchModule

public interface SearchModule

Search implementation must implement this interface

Author:

carlsamson

Method Summary

Modifier and Type	Method	Description
void	configure(SearchConfiguration configuration)
void	delete(List<String> languages, Long id)	Index having description (language) Document id
Object	getConnection()
Optional<Document>	getDocument(Long id, String language, RequestOptions option)	Get Document for a specific language
List<Optional<Document>>	getDocument(Long id, List<String> languages, RequestOptions option)	Get document id for differet languases
String	getUniqueCode()	Search module code
void	index(List<IndexItem> item)
void	index(IndexItem item)
SearchResponse	searchKeywords(SearchRequest searchRequest)
SearchResponse	searchProducts(SearchRequest searchRequest)

Method Detail

configure

void configure(SearchConfiguration configuration)
        throws Exception

Throws:

Exception

index

void index(IndexItem item)
    throws Exception

Throws:

Exception

index

void index(List<IndexItem> item)
    throws Exception

Throws:

Exception

delete

void delete(List<String> languages,
            Long id)
     throws Exception

Index having description (language) Document id

Parameters:

languages -

id -

Throws:

Exception

getUniqueCode

String getUniqueCode()

Search module code

Returns:

searchKeywords

SearchResponse searchKeywords(SearchRequest searchRequest)
                       throws Exception

Throws:

Exception

searchProducts

SearchResponse searchProducts(SearchRequest searchRequest)
                       throws Exception

Throws:

Exception

getDocument

Optional<Document> getDocument(Long id,
                               String language,
                               RequestOptions option)
                        throws Exception

Get Document for a specific language

Parameters:

id -

language -

Returns:

Throws:

Exception

getDocument

List<Optional<Document>> getDocument(Long id,
                                     List<String> languages,
                                     RequestOptions option)
                              throws Exception

Get document id for differet languases

Parameters:

id -

languages -

Returns:

Throws:

Exception

getConnection

Object getConnection()