com.loop54.model.request

Class SearchRequest

java.lang.Object

com.loop54.model.request.Request

com.loop54.model.request.SearchRequest

public class SearchRequest
extends Request

This class is used to configure a search request to the Loop54 e-commerce search engine.

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	query The search query from the end-user.
QueryCollectionParameters	relatedQueriesOptions Parameters for specifying how related queries should be retrieved.
EntityCollectionParameters	relatedResultsOptions Parameters for specifying which related results to retrieve.
EntityCollectionParameters	resultsOptions Parameters for specifying which direct results to retrieve.
QueryCollectionParameters	spellingSuggestionsOptions Parameters for specifying how spelling suggestions should be retrieved.

Fields inherited from class com.loop54.model.request.Request

customData

Constructor Summary

Constructors

Constructor and Description
SearchRequest(java.lang.String query) The search query from the end-user.

Method Summary

Methods inherited from class com.loop54.model.request.Request

addCustomData

Methods inherited from class java.lang.Object

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

Field Detail

query

public final java.lang.String query

The search query from the end-user. Can at most be 200 chars long.

resultsOptions

public final EntityCollectionParameters resultsOptions

Parameters for specifying which direct results to retrieve. Such as filtering, faceting, sorting and paging. Only affects the direct results, to modify the related results use relatedResultsOptions.

relatedResultsOptions

public final EntityCollectionParameters relatedResultsOptions

Parameters for specifying which related results to retrieve. Such as filtering, faceting, sorting and paging. Only affects the related results, to modify the direct results use resultsOptions.

spellingSuggestionsOptions

public final QueryCollectionParameters spellingSuggestionsOptions

Parameters for specifying how spelling suggestions should be retrieved. Contains paging and sorting options.

relatedQueriesOptions

public final QueryCollectionParameters relatedQueriesOptions

Parameters for specifying how related queries should be retrieved. Contains paging and sorting options.

Constructor Detail

SearchRequest

public SearchRequest(java.lang.String query)

The search query from the end-user. Can at most be 200 chars long.

Parameters:

query - The query to search for.