Package com.loop54.model.request

Class AutoCompleteRequest

java.lang.Object

com.loop54.model.request.Request

com.loop54.model.request.AutoCompleteRequest

public class AutoCompleteRequest
extends Request

This class is used for performing auto-complete requests to the Loop54 e-commerce search engine.

Field Summary

Fields

Modifier and Type	Field	Description
final QueryCollectionParameters	queriesOptions	Parameters for specifying how the auto-complete results should be retrieved.
final String	query	The partial query that the user has entered.

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

customData

Constructor Summary

Constructors

Constructor	Description
AutoCompleteRequest(String query)	The partial query that the user has entered.

Method Summary

Modifier and Type	Method	Description
AutoCompleteRequest	withCustomData(String key, Object value)	Chainable variant of Request.addCustomData(String, Object).
AutoCompleteRequest	withQueries(Consumer<QueryCollectionParameters> configurator)	Configures queriesOptions, e.g.

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 Details

query

public final String query

The partial query that the user has entered.

queriesOptions

public final QueryCollectionParameters queriesOptions

Parameters for specifying how the auto-complete results should be retrieved. Contains paging and sorting options.

Constructor Details

AutoCompleteRequest

public AutoCompleteRequest(String query)

The partial query that the user has entered.

Parameters:

query - the query to get auto complete suggestions for.

Method Details

withQueries

public AutoCompleteRequest withQueries(Consumer<QueryCollectionParameters> configurator)

Configures queriesOptions, e.g. request.withQueries(q -> q.page(0, 10)).

Parameters:

configurator - Applied to queriesOptions.

Returns:

This request, for chaining.

withCustomData

public AutoCompleteRequest withCustomData(String key,
 Object value)

Description copied from class: Request

Chainable variant of Request.addCustomData(String, Object). Subclasses override this to return their own type.

Overrides:

withCustomData in class Request

Parameters:

key - Key to set the data on. The keys will be treated as case-sensitive.

value - Value to add to the custom data.

Returns:

This request, for chaining.