Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- add(String, Loop54Settings) - Method in class com.loop54.Loop54SettingsCollection
-
Adds a named setting to the collection.
- add(String, String) - Method in class com.loop54.Loop54SettingsCollection
-
Adds a named endpoint setting to the collection.
- ADD_TO_CART - Static variable in class com.loop54.model.request.parameters.Event
-
The string value corresponding to the addtocart-event
- addCustomData(String, Object) - Method in class com.loop54.model.request.Request
-
Adds the object value using the provided key to the custom data of the request.
- addDistinctFacet(String) - Method in class com.loop54.model.request.parameters.EntityCollectionParameters
-
Adds a facet with the type
FacetType.DISTINCTto the entity collection parameter. - addDistinctFacet(String, List<?>) - Method in class com.loop54.model.request.parameters.EntityCollectionParameters
-
Adds a facet with the type
FacetType.DISTINCTto the entity collection parameter. - addDistinctFacet(String, List<?>, String, List<DistinctFacetItemSortingParameter>) - Method in class com.loop54.model.request.parameters.EntityCollectionParameters
-
Adds a facet with the type
FacetType.DISTINCTto the entity collection parameter. - addRangeFacet(String) - Method in class com.loop54.model.request.parameters.EntityCollectionParameters
-
Adds a facet with the type
FacetType.RANGEto the entity collection parameter. - addRangeFacet(String, RangeFacetParameter.RangeFacetSelectedParameter<?>, String) - Method in class com.loop54.model.request.parameters.EntityCollectionParameters
-
Adds a facet with the type
FacetType.RANGEto the entity collection parameter. - AddToCartEvent - Class in com.loop54.model.request.parameters
-
Event for when a user has added a product to the shopping cart.
- AddToCartEvent(Entity) - Constructor for class com.loop54.model.request.parameters.AddToCartEvent
- ALPHABETIC - Enum constant in enum class com.loop54.model.request.parameters.QuerySortingParameter.Types
- and - Variable in class com.loop54.model.request.parameters.filters.AndFilterParameter
-
The filters that should be combined.
- AndFilterParameter - Class in com.loop54.model.request.parameters.filters
-
Used for combining two or more filters using AND-logic
- AndFilterParameter() - Constructor for class com.loop54.model.request.parameters.filters.AndFilterParameter
- AndFilterParameter(FilterParameter...) - Constructor for class com.loop54.model.request.parameters.filters.AndFilterParameter
- API_KEY - Static variable in class com.loop54.http.Headers
- API_VERSION - Static variable in class com.loop54.VersionHeaders
- API_VERSION_HEADER - Static variable in class com.loop54.VersionHeaders
- ARRAY - Enum constant in enum class com.loop54.model.EntityAttributeType
- ASC - Enum constant in enum class com.loop54.model.request.parameters.SortOrders
- attribute - Variable in class com.loop54.model.request.GetEntitiesByAttributeRequest
-
The attribute name-value-pair to find entities connected to.
- ATTRIBUTE - Enum constant in enum class com.loop54.model.request.parameters.EntitySortingParameter.Types
-
Sort the entities by a specific attribute that exist in your catalogue.
- ATTRIBUTE - Enum constant in enum class com.loop54.model.request.parameters.filters.FilterParameterType
-
Compares against an attribute on the entity
- AttributeExistsFilterParameter - Class in com.loop54.model.request.parameters.filters
-
Used for filtering entities that have a certain attribute, regardless of the value.
- AttributeExistsFilterParameter(String) - Constructor for class com.loop54.model.request.parameters.filters.AttributeExistsFilterParameter
- AttributeFilterParameter<T> - Class in com.loop54.model.request.parameters.filters
-
Used for filtering entities that have a certain attribute value.
- AttributeFilterParameter(FilterParameterType, T) - Constructor for class com.loop54.model.request.parameters.filters.AttributeFilterParameter
- AttributeFilterParameter(String, T) - Constructor for class com.loop54.model.request.parameters.filters.AttributeFilterParameter
-
Constructor.
- attributeName - Variable in class com.loop54.model.request.parameters.EntitySortingParameter
-
If choosing to sort by
EntitySortingParameter.Types.ATTRIBUTEthis property specifies which attribute to sort by. - attributeName - Variable in class com.loop54.model.request.parameters.facets.FacetParameter
-
The name of the attribute on the entities to facet the result on.
- attributeName - Variable in class com.loop54.model.request.parameters.filters.AttributeExistsFilterParameter
-
The attribute to look for.
- attributeName - Variable in class com.loop54.model.request.parameters.filters.AttributeFilterParameter
-
The name of attribute to filter on.
- AttributeNameValuePair - Class in com.loop54.model.request
- AttributeNameValuePair() - Constructor for class com.loop54.model.request.AttributeNameValuePair
- AttributeNameValuePairMulti - Class in com.loop54.model.request
-
Name-value-pair to identify an attribute to filter by.
- AttributeNameValuePairMulti() - Constructor for class com.loop54.model.request.AttributeNameValuePairMulti
- AttributeNameValuePairSingle - Class in com.loop54.model.request
-
Name-value-pair to identify an attribute to filter by.
- AttributeNameValuePairSingle() - Constructor for class com.loop54.model.request.AttributeNameValuePairSingle
- autoComplete(AutoCompleteRequest) - Method in interface com.loop54.ILoop54Client
- autoComplete(AutoCompleteRequest) - Method in class com.loop54.Loop54Client
- autoComplete(RequestContainer<AutoCompleteRequest>) - Method in interface com.loop54.ILoop54Client
- autoComplete(RequestContainer<AutoCompleteRequest>) - Method in class com.loop54.Loop54Client
- autoCompleteAsync(AutoCompleteRequest) - Method in interface com.loop54.ILoop54Client
- autoCompleteAsync(AutoCompleteRequest) - Method in class com.loop54.Loop54Client
- autoCompleteAsync(RequestContainer<AutoCompleteRequest>) - Method in interface com.loop54.ILoop54Client
- autoCompleteAsync(RequestContainer<AutoCompleteRequest>) - Method in class com.loop54.Loop54Client
- AutoCompleteRequest - Class in com.loop54.model.request
-
This class is used for performing auto-complete requests to the Loop54 e-commerce search engine.
- AutoCompleteRequest(String) - Constructor for class com.loop54.model.request.AutoCompleteRequest
-
The partial query that the user has entered.
- AutoCompleteResponse - Class in com.loop54.model.response
-
The result of an autocomplete request.
- AutoCompleteResponse() - Constructor for class com.loop54.model.response.AutoCompleteResponse
B
- behaviorType - Variable in class com.loop54.model.request.GetPopularOrRecentEntitiesRequest
-
The interaction or navigation type to include (such as click, purchase or search).
- BOOLEAN - Enum constant in enum class com.loop54.model.EntityAttributeType
C
- callEngineAsync(String, Request, UserMetaData, Class<T>) - Method in interface com.loop54.http.IRequestManager
-
Calls the loop54 search engine and returns a deserialized response object.
- callEngineAsync(String, Request, UserMetaData, Class<T>) - Method in class com.loop54.http.RequestManager
- CLICK - Static variable in class com.loop54.model.request.parameters.Event
-
The string value corresponding to the click-event
- ClickEvent - Class in com.loop54.model.request.parameters
-
Event for when a user has clicked on a product.
- ClickEvent(Entity) - Constructor for class com.loop54.model.request.parameters.ClickEvent
- ClientInfoException - Exception in com.loop54.exceptions
-
Thrown when we cannot read the client info properly.
- ClientInfoException(String) - Constructor for exception com.loop54.exceptions.ClientInfoException
- close() - Method in class com.loop54.http.RequestManager
-
Closes the underlying HTTP client and releases any system resources associated with it.
- close() - Method in class com.loop54.Loop54Client
-
Closes the underlying request manager and releases any system resources associated with it.
- close() - Method in class com.loop54.Loop54ClientProvider
-
Closes all clients and releases any system resources associated with them.
- code - Variable in class com.loop54.model.response.ErrorDetails
-
The HTTP status code of the response.
- com.loop54 - package com.loop54
- com.loop54.exceptions - package com.loop54.exceptions
- com.loop54.http - package com.loop54.http
- com.loop54.model - package com.loop54.model
- com.loop54.model.request - package com.loop54.model.request
- com.loop54.model.request.parameters - package com.loop54.model.request.parameters
- com.loop54.model.request.parameters.facets - package com.loop54.model.request.parameters.facets
- com.loop54.model.request.parameters.filters - package com.loop54.model.request.parameters.filters
- com.loop54.model.response - package com.loop54.model.response
- com.loop54.serialization - package com.loop54.serialization
- com.loop54.user - package com.loop54.user
- comparisonMode - Variable in class com.loop54.model.request.parameters.filters.AttributeFilterParameter
-
How to compare the attribute value against the provided value.
- CONTAINS - Enum constant in enum class com.loop54.model.request.parameters.filters.FilterComparisonMode
-
Only available if filtering on strings.
- count - Variable in class com.loop54.model.response.DistinctFacet.DistinctFacetItem
-
Number of entities belonging to this option.
- count - Variable in class com.loop54.model.response.EntityCollection
-
The total number of entities that are available to return after filtering and faceting but before paging.
- count - Variable in class com.loop54.model.response.QueryCollection
-
The total number of queries available before paging.
- COUNT - Enum constant in enum class com.loop54.model.request.parameters.facets.DistinctFacetItemSortingParameter.Types
- create() - Static method in class com.loop54.Loop54SettingsCollection
-
Will create and return a new, empty instance of
Loop54SettingsCollection. - createEvents(CreateEventsRequest) - Method in interface com.loop54.ILoop54Client
- createEvents(CreateEventsRequest) - Method in class com.loop54.Loop54Client
- createEvents(RequestContainer<CreateEventsRequest>) - Method in interface com.loop54.ILoop54Client
- createEvents(RequestContainer<CreateEventsRequest>) - Method in class com.loop54.Loop54Client
- createEventsAsync(CreateEventsRequest) - Method in interface com.loop54.ILoop54Client
- createEventsAsync(CreateEventsRequest) - Method in class com.loop54.Loop54Client
- createEventsAsync(RequestContainer<CreateEventsRequest>) - Method in interface com.loop54.ILoop54Client
- createEventsAsync(RequestContainer<CreateEventsRequest>) - Method in class com.loop54.Loop54Client
- CreateEventsRequest - Class in com.loop54.model.request
-
This class is used to configure a GetEntities request to the Loop54 e-commerce search engine.
- CreateEventsRequest() - Constructor for class com.loop54.model.request.CreateEventsRequest
- CreateEventsRequest(Event) - Constructor for class com.loop54.model.request.CreateEventsRequest
- CURRENT_USER_PLACEHOLDER - Static variable in class com.loop54.model.request.GetPopularOrRecentEntitiesRequest
-
Represents a placeholder value used in `GetRecentEntitiesRequest` and `GetPopularEntitiesRequest` to indicate that the request should target the current user's data.
- customCall(String, Request) - Method in interface com.loop54.ILoop54Client
- customCall(String, Request) - Method in class com.loop54.Loop54Client
- customCall(String, RequestContainer<Request>) - Method in interface com.loop54.ILoop54Client
- customCall(String, RequestContainer<Request>) - Method in class com.loop54.Loop54Client
- customCallAsync(String, Request) - Method in interface com.loop54.ILoop54Client
- customCallAsync(String, Request) - Method in class com.loop54.Loop54Client
- customCallAsync(String, RequestContainer<Request>) - Method in interface com.loop54.ILoop54Client
- customCallAsync(String, RequestContainer<Request>) - Method in class com.loop54.Loop54Client
- customData - Variable in class com.loop54.model.request.Request
-
Any additional, non-standard, data.
- customData - Variable in class com.loop54.model.response.Response
-
Any additional, non-standard, data.
- CustomEvent - Class in com.loop54.model.request.parameters
-
Event for when a user has purchased a product.
- CustomEvent(String, Entity) - Constructor for class com.loop54.model.request.parameters.CustomEvent
D
- DATE - Enum constant in enum class com.loop54.model.EntityAttributeType
- DESC - Enum constant in enum class com.loop54.model.request.parameters.SortOrders
- deserialize(JsonParser, DeserializationContext) - Method in class com.loop54.serialization.FacetJsonDeserializer
- deserialize(String, Class<T>) - Static method in class com.loop54.serialization.Serializer
- deserialize(LinkedHashMap, Class<T>) - Static method in class com.loop54.serialization.Serializer
- detail - Variable in class com.loop54.model.response.ErrorDetails
-
The more detailed information about the error.
- details - Variable in exception com.loop54.exceptions.EngineStatusCodeException
-
Details about the error provided by the engine.
- details - Variable in class com.loop54.model.request.RequestAliasData
-
Specify a more detailed description for this attribute name–value pair.
- DISTINCT - Enum constant in enum class com.loop54.model.FacetType
-
A facet should consist of a finite number of options with the number of connected entities as the values.
- DistinctFacet - Class in com.loop54.model.response
-
This class provides results for a distinct facet.
- DistinctFacet() - Constructor for class com.loop54.model.response.DistinctFacet
- DistinctFacet.DistinctFacetItem - Class in com.loop54.model.response
-
Represents a facet option found in the result set.
- DistinctFacetItem() - Constructor for class com.loop54.model.response.DistinctFacet.DistinctFacetItem
- DistinctFacetItemSortingParameter - Class in com.loop54.model.request.parameters.facets
-
Describes how to sort the items returned in the facet.
- DistinctFacetItemSortingParameter() - Constructor for class com.loop54.model.request.parameters.facets.DistinctFacetItemSortingParameter
- DistinctFacetItemSortingParameter.Types - Enum Class in com.loop54.model.request.parameters.facets
- DistinctFacetParameter<T> - Class in com.loop54.model.request.parameters.facets
-
Used for distinct faceting of entities.
- DistinctFacetParameter(String, List<T>, String, List<DistinctFacetItemSortingParameter>) - Constructor for class com.loop54.model.request.parameters.facets.DistinctFacetParameter
E
- EngineNotReachableException - Exception in com.loop54.exceptions
-
Thrown when a connection to the engine cannot be made.
- EngineNotReachableException(String, Exception) - Constructor for exception com.loop54.exceptions.EngineNotReachableException
- EngineStatusCodeException - Exception in com.loop54.exceptions
-
Thrown when the engine is reachable, but the response status code was not 200.
- EngineStatusCodeException(ErrorDetails) - Constructor for exception com.loop54.exceptions.EngineStatusCodeException
- entities - Variable in class com.loop54.model.request.GetBasketRecommendationsRequest
-
The set of entities in the basket to get recommendations for.
- entity - Variable in class com.loop54.model.request.GetComplementaryEntitiesRequest
-
The entity whose complementary entities we want to get.
- entity - Variable in class com.loop54.model.request.GetRelatedEntitiesRequest
-
The entity who's related entities we want to get.
- entity - Variable in class com.loop54.model.request.parameters.Event
-
The entity that the user has interacted with.
- Entity - Class in com.loop54.model
-
An entity represents one Product (or document).
- Entity(String, String) - Constructor for class com.loop54.model.Entity
- EntityAttribute - Class in com.loop54.model
-
Represents an attribute on an entity in the loop54 search engine.
- EntityAttribute(String, EntityAttributeType, List<Object>) - Constructor for class com.loop54.model.EntityAttribute
- EntityAttributeType - Enum Class in com.loop54.model
- EntityCollection - Class in com.loop54.model.response
-
A collection of entities returned by the Loop54 e-commerce search engine.
- EntityCollection() - Constructor for class com.loop54.model.response.EntityCollection
- EntityCollectionParameters - Class in com.loop54.model.request.parameters
-
This class specifies how a collection of entities should be paged, filtered, sorted and faceted.
- EntityCollectionParameters() - Constructor for class com.loop54.model.request.parameters.EntityCollectionParameters
- EntitySortingParameter - Class in com.loop54.model.request.parameters
-
This class is used to specify how to sort entities in a response from the Loop54 e-commerce search engine.
- EntitySortingParameter() - Constructor for class com.loop54.model.request.parameters.EntitySortingParameter
- EntitySortingParameter(EntitySortingParameter.Types) - Constructor for class com.loop54.model.request.parameters.EntitySortingParameter
- EntitySortingParameter(String) - Constructor for class com.loop54.model.request.parameters.EntitySortingParameter
-
Used when wanting to order on a certain attribute on the entities.
- EntitySortingParameter.Types - Enum Class in com.loop54.model.request.parameters
- entityType - Variable in class com.loop54.model.request.GetPopularOrRecentEntitiesRequest
-
The entity types to include (such as Product or Query) or null for all.
- EQUALS - Enum constant in enum class com.loop54.model.request.parameters.filters.FilterComparisonMode
- error - Variable in class com.loop54.model.response.ErrorResponse
-
Details about the error.
- ErrorDetails - Class in com.loop54.model.response
-
Detailed information regarding an error returned from the engine.
- ErrorDetails() - Constructor for class com.loop54.model.response.ErrorDetails
- ErrorResponse - Class in com.loop54.model.response
-
Response returned by the engine when an error has occurred.
- ErrorResponse() - Constructor for class com.loop54.model.response.ErrorResponse
- Event - Class in com.loop54.model.request.parameters
-
Base event class.
- Event(String, Entity) - Constructor for class com.loop54.model.request.parameters.Event
- events - Variable in class com.loop54.model.request.CreateEventsRequest
-
The events to send in the request.
F
- Facet - Class in com.loop54.model.response
-
Base class containing facet information returned by the Loop54 e-commerce search engine.
- Facet() - Constructor for class com.loop54.model.response.Facet
- FacetJsonDeserializer - Class in com.loop54.serialization
- FacetJsonDeserializer() - Constructor for class com.loop54.serialization.FacetJsonDeserializer
- FacetParameter - Class in com.loop54.model.request.parameters.facets
-
Used for faceting an entity collection based on the attributes of the entities.
- FacetParameter(String) - Constructor for class com.loop54.model.request.parameters.facets.FacetParameter
- facets - Variable in class com.loop54.model.request.parameters.EntityCollectionParameters
-
List of facets to calculate and possibly filter the result on.
- facets - Variable in class com.loop54.model.response.EntityCollection
-
The facets calculated for the result set.
- FacetType - Enum Class in com.loop54.model
-
Represent the two types of facets available to make.
- filter - Variable in class com.loop54.model.request.parameters.EntityCollectionParameters
-
How the results should be filtered.
- FilterComparisonMode - Enum Class in com.loop54.model.request.parameters.filters
-
How values should be compared to the attribute values of the entities being filtered.
- FilterParameter - Class in com.loop54.model.request.parameters.filters
-
Used for filtering entities in a result set.
- FilterParameter() - Constructor for class com.loop54.model.request.parameters.filters.FilterParameter
- FilterParameterType - Enum Class in com.loop54.model.request.parameters.filters
-
Specifies the type of a attribute filter.
- fixEngineUrl(String) - Static method in class com.loop54.Utils
-
Trims and validates a URL.
- forCurrentUser(String, List<String>) - Static method in class com.loop54.model.request.GetPopularEntitiesRequest
-
Creates a request to get the most popular entities for the current user.
- forCurrentUser(String, List<String>) - Static method in class com.loop54.model.request.GetRecentEntitiesRequest
-
Creates a request to get the most recent entities for the current user.
- forUserId - Variable in class com.loop54.model.request.GetPopularOrRecentEntitiesRequest
-
A user ID to retrieve the most common/recent entities for that user or null to retrieve the globally most common/recent entities.
G
- generateUserId() - Static method in class com.loop54.Utils
-
Generates a new random UserId.
- getApiKey() - Method in class com.loop54.Loop54Settings
- getAttributes() - Method in class com.loop54.model.Entity
-
All attributes available on the entity.
- getAttributeValueOrNull(String, Class<T>) - Method in class com.loop54.model.Entity
-
Gets the attribute value with the desired name and type.
- getAttributeValuesOrNull(String, Class<T>) - Method in class com.loop54.model.Entity
-
Gets the attribute values with the desired name and type.
- getBasketRecommendations(GetBasketRecommendationsRequest) - Method in interface com.loop54.ILoop54Client
- getBasketRecommendations(GetBasketRecommendationsRequest) - Method in class com.loop54.Loop54Client
- getBasketRecommendations(RequestContainer<GetBasketRecommendationsRequest>) - Method in interface com.loop54.ILoop54Client
- getBasketRecommendations(RequestContainer<GetBasketRecommendationsRequest>) - Method in class com.loop54.Loop54Client
- getBasketRecommendationsAsync(GetBasketRecommendationsRequest) - Method in interface com.loop54.ILoop54Client
- getBasketRecommendationsAsync(GetBasketRecommendationsRequest) - Method in class com.loop54.Loop54Client
- getBasketRecommendationsAsync(RequestContainer<GetBasketRecommendationsRequest>) - Method in interface com.loop54.ILoop54Client
- getBasketRecommendationsAsync(RequestContainer<GetBasketRecommendationsRequest>) - Method in class com.loop54.Loop54Client
- GetBasketRecommendationsRequest - Class in com.loop54.model.request
-
This class is used to configure a GetBasketRecommendations request to the Loop54 e-commerce search engine.
- GetBasketRecommendationsRequest(List<Entity>) - Constructor for class com.loop54.model.request.GetBasketRecommendationsRequest
- GetBasketRecommendationsResponse - Class in com.loop54.model.response
-
The result of a getBasketRecommendations request.
- GetBasketRecommendationsResponse() - Constructor for class com.loop54.model.response.GetBasketRecommendationsResponse
- getComplementaryEntities(GetComplementaryEntitiesRequest) - Method in interface com.loop54.ILoop54Client
- getComplementaryEntities(GetComplementaryEntitiesRequest) - Method in class com.loop54.Loop54Client
- getComplementaryEntities(RequestContainer<GetComplementaryEntitiesRequest>) - Method in interface com.loop54.ILoop54Client
- getComplementaryEntities(RequestContainer<GetComplementaryEntitiesRequest>) - Method in class com.loop54.Loop54Client
- getComplementaryEntitiesAsync(GetComplementaryEntitiesRequest) - Method in interface com.loop54.ILoop54Client
- getComplementaryEntitiesAsync(GetComplementaryEntitiesRequest) - Method in class com.loop54.Loop54Client
- getComplementaryEntitiesAsync(RequestContainer<GetComplementaryEntitiesRequest>) - Method in interface com.loop54.ILoop54Client
- getComplementaryEntitiesAsync(RequestContainer<GetComplementaryEntitiesRequest>) - Method in class com.loop54.Loop54Client
- GetComplementaryEntitiesRequest - Class in com.loop54.model.request
-
This class is used to configure a GetComplementaryEntities request to the Loop54 e-commerce search engine.
- GetComplementaryEntitiesRequest(Entity) - Constructor for class com.loop54.model.request.GetComplementaryEntitiesRequest
- GetComplementaryEntitiesRequest(String, String) - Constructor for class com.loop54.model.request.GetComplementaryEntitiesRequest
- GetComplementaryEntitiesResponse - Class in com.loop54.model.response
-
The result of a getComplementaryEntities request.
- GetComplementaryEntitiesResponse() - Constructor for class com.loop54.model.response.GetComplementaryEntitiesResponse
- getCookie(String) - Method in interface com.loop54.user.IRemoteClientInfo
-
Gets the value of a cookie with a given name.
- getCookie(String) - Method in class com.loop54.user.NullClientInfo
- getCustomDataOrDefault(String, Class<T>) - Method in class com.loop54.model.response.Response
-
Retrieve a named custom value from the response.
- getCustomDataOrThrow(String, Class<T>) - Method in class com.loop54.model.response.Response
-
Retrieve a named custom value from the response.
- getDistinctFacetByName(String) - Method in class com.loop54.model.response.EntityCollection
- getEndpoint() - Method in class com.loop54.Loop54Settings
- getEntities(GetEntitiesRequest) - Method in interface com.loop54.ILoop54Client
- getEntities(GetEntitiesRequest) - Method in class com.loop54.Loop54Client
- getEntities(RequestContainer<GetEntitiesRequest>) - Method in interface com.loop54.ILoop54Client
- getEntities(RequestContainer<GetEntitiesRequest>) - Method in class com.loop54.Loop54Client
- getEntitiesAsync(GetEntitiesRequest) - Method in interface com.loop54.ILoop54Client
- getEntitiesAsync(GetEntitiesRequest) - Method in class com.loop54.Loop54Client
- getEntitiesAsync(RequestContainer<GetEntitiesRequest>) - Method in interface com.loop54.ILoop54Client
- getEntitiesAsync(RequestContainer<GetEntitiesRequest>) - Method in class com.loop54.Loop54Client
- getEntitiesByAttribute(GetEntitiesByAttributeRequest) - Method in interface com.loop54.ILoop54Client
- getEntitiesByAttribute(GetEntitiesByAttributeRequest) - Method in class com.loop54.Loop54Client
- getEntitiesByAttribute(RequestContainer<GetEntitiesByAttributeRequest>) - Method in interface com.loop54.ILoop54Client
- getEntitiesByAttribute(RequestContainer<GetEntitiesByAttributeRequest>) - Method in class com.loop54.Loop54Client
- getEntitiesByAttributeAsync(GetEntitiesByAttributeRequest) - Method in interface com.loop54.ILoop54Client
- getEntitiesByAttributeAsync(GetEntitiesByAttributeRequest) - Method in class com.loop54.Loop54Client
- getEntitiesByAttributeAsync(RequestContainer<GetEntitiesByAttributeRequest>) - Method in interface com.loop54.ILoop54Client
- getEntitiesByAttributeAsync(RequestContainer<GetEntitiesByAttributeRequest>) - Method in class com.loop54.Loop54Client
- GetEntitiesByAttributeRequest - Class in com.loop54.model.request
-
This class is used to configure a GetEntities request to the Loop54 e-commerce search engine.
- GetEntitiesByAttributeRequest(String, String) - Constructor for class com.loop54.model.request.GetEntitiesByAttributeRequest
- GetEntitiesByAttributeRequest(String, String[]) - Constructor for class com.loop54.model.request.GetEntitiesByAttributeRequest
- GetEntitiesByAttributeRequest(String, String[], RequestAliasData) - Constructor for class com.loop54.model.request.GetEntitiesByAttributeRequest
- GetEntitiesByAttributeRequest(String, String, RequestAliasData) - Constructor for class com.loop54.model.request.GetEntitiesByAttributeRequest
- GetEntitiesByAttributeResponse - Class in com.loop54.model.response
-
The result of a request to get entities with an attribute (for instance category).
- GetEntitiesByAttributeResponse() - Constructor for class com.loop54.model.response.GetEntitiesByAttributeResponse
- GetEntitiesRequest - Class in com.loop54.model.request
-
This class is used to configure a GetEntities request to the Loop54 e-commerce search engine.
- GetEntitiesRequest() - Constructor for class com.loop54.model.request.GetEntitiesRequest
- GetEntitiesResponse - Class in com.loop54.model.response
-
The results of a getEntitites request.
- GetEntitiesResponse() - Constructor for class com.loop54.model.response.GetEntitiesResponse
- getItem(Class<T>) - Method in class com.loop54.model.response.DistinctFacet.DistinctFacetItem
-
Gets the facet option as the type provided.
- getItems() - Method in class com.loop54.model.response.DistinctFacet
-
The options found for this facet.
- getMax(Class<T>) - Method in class com.loop54.model.response.RangeFacet
-
Gets the maximum value of the facet.
- getMin(Class<T>) - Method in class com.loop54.model.response.RangeFacet
-
Gets the minimum value of the facet.
- getName() - Method in class com.loop54.model.EntityAttribute
- getName() - Method in class com.loop54.model.response.Facet
-
The name of the facet (as set in the request).
- getNamed(String) - Method in interface com.loop54.ILoop54ClientProvider
-
Get a named instance of ILoop54Client.
- getNamed(String) - Method in class com.loop54.Loop54ClientProvider
-
Get a named instance of ILoop54Client.
- getPopularEntities(GetPopularEntitiesRequest) - Method in interface com.loop54.ILoop54Client
- getPopularEntities(GetPopularEntitiesRequest) - Method in class com.loop54.Loop54Client
- getPopularEntities(RequestContainer<GetPopularEntitiesRequest>) - Method in interface com.loop54.ILoop54Client
- getPopularEntities(RequestContainer<GetPopularEntitiesRequest>) - Method in class com.loop54.Loop54Client
- getPopularEntitiesAsync(GetPopularEntitiesRequest) - Method in interface com.loop54.ILoop54Client
- getPopularEntitiesAsync(GetPopularEntitiesRequest) - Method in class com.loop54.Loop54Client
- getPopularEntitiesAsync(RequestContainer<GetPopularEntitiesRequest>) - Method in interface com.loop54.ILoop54Client
- getPopularEntitiesAsync(RequestContainer<GetPopularEntitiesRequest>) - Method in class com.loop54.Loop54Client
- GetPopularEntitiesRequest - Class in com.loop54.model.request
-
This class used to perform a request to get entities that a user (or all users) most commonly interacted with or navigated to.
- GetPopularEntitiesRequest(String) - Constructor for class com.loop54.model.request.GetPopularEntitiesRequest
-
Retrieve the globally most common products
- GetPopularEntitiesRequest(String, String) - Constructor for class com.loop54.model.request.GetPopularEntitiesRequest
-
Retrieve the globally most common entities for a specfic user
- GetPopularEntitiesRequest(String, String, List<String>) - Constructor for class com.loop54.model.request.GetPopularEntitiesRequest
- GetPopularEntitiesResponse - Class in com.loop54.model.response
-
The results of a getPopularEntities request.
- GetPopularEntitiesResponse() - Constructor for class com.loop54.model.response.GetPopularEntitiesResponse
- GetPopularOrRecentEntitiesRequest - Class in com.loop54.model.request
-
Base class for requests to get the most popular or most recent entities.
- GetPopularOrRecentEntitiesRequest(String, String, List<String>) - Constructor for class com.loop54.model.request.GetPopularOrRecentEntitiesRequest
- getRangeFacetByName(String) - Method in class com.loop54.model.response.EntityCollection
- getRecentEntities(GetRecentEntitiesRequest) - Method in interface com.loop54.ILoop54Client
- getRecentEntities(GetRecentEntitiesRequest) - Method in class com.loop54.Loop54Client
- getRecentEntities(RequestContainer<GetRecentEntitiesRequest>) - Method in interface com.loop54.ILoop54Client
- getRecentEntities(RequestContainer<GetRecentEntitiesRequest>) - Method in class com.loop54.Loop54Client
- getRecentEntitiesAsync(GetRecentEntitiesRequest) - Method in interface com.loop54.ILoop54Client
- getRecentEntitiesAsync(GetRecentEntitiesRequest) - Method in class com.loop54.Loop54Client
- getRecentEntitiesAsync(RequestContainer<GetRecentEntitiesRequest>) - Method in interface com.loop54.ILoop54Client
- getRecentEntitiesAsync(RequestContainer<GetRecentEntitiesRequest>) - Method in class com.loop54.Loop54Client
- GetRecentEntitiesRequest - Class in com.loop54.model.request
-
This class used to perform a request to get entities that a user (or all users) most recently interacted with or navigated to.
- GetRecentEntitiesRequest(String) - Constructor for class com.loop54.model.request.GetRecentEntitiesRequest
-
Retrieve the globally most recent products
- GetRecentEntitiesRequest(String, String) - Constructor for class com.loop54.model.request.GetRecentEntitiesRequest
-
Retrieve the globally most recent products for a specfic user
- GetRecentEntitiesRequest(String, String, List<String>) - Constructor for class com.loop54.model.request.GetRecentEntitiesRequest
- GetRecentEntitiesResponse - Class in com.loop54.model.response
-
The results of a getRecentEntities request.
- GetRecentEntitiesResponse() - Constructor for class com.loop54.model.response.GetRecentEntitiesResponse
- getRecommendedEntities(GetRecommendedEntitiesRequest) - Method in interface com.loop54.ILoop54Client
- getRecommendedEntities(GetRecommendedEntitiesRequest) - Method in class com.loop54.Loop54Client
- getRecommendedEntities(RequestContainer<GetRecommendedEntitiesRequest>) - Method in interface com.loop54.ILoop54Client
- getRecommendedEntities(RequestContainer<GetRecommendedEntitiesRequest>) - Method in class com.loop54.Loop54Client
- getRecommendedEntitiesAsync(GetRecommendedEntitiesRequest) - Method in interface com.loop54.ILoop54Client
- getRecommendedEntitiesAsync(GetRecommendedEntitiesRequest) - Method in class com.loop54.Loop54Client
- getRecommendedEntitiesAsync(RequestContainer<GetRecommendedEntitiesRequest>) - Method in interface com.loop54.ILoop54Client
- getRecommendedEntitiesAsync(RequestContainer<GetRecommendedEntitiesRequest>) - Method in class com.loop54.Loop54Client
- GetRecommendedEntitiesRequest - Class in com.loop54.model.request
-
This class is used to perform a request to get personalized recommendations.
- GetRecommendedEntitiesRequest() - Constructor for class com.loop54.model.request.GetRecommendedEntitiesRequest
- GetRecommendedEntitiesResponse - Class in com.loop54.model.response
-
TThe result of a request to get personalized recommendations.
- GetRecommendedEntitiesResponse() - Constructor for class com.loop54.model.response.GetRecommendedEntitiesResponse
- getReferrer() - Method in interface com.loop54.user.IRemoteClientInfo
-
Get the Referer(sic) header sent by the end-user.
- getReferrer() - Method in class com.loop54.user.NullClientInfo
- getRelatedEntities(GetRelatedEntitiesRequest) - Method in interface com.loop54.ILoop54Client
- getRelatedEntities(GetRelatedEntitiesRequest) - Method in class com.loop54.Loop54Client
- getRelatedEntities(RequestContainer<GetRelatedEntitiesRequest>) - Method in interface com.loop54.ILoop54Client
- getRelatedEntities(RequestContainer<GetRelatedEntitiesRequest>) - Method in class com.loop54.Loop54Client
- getRelatedEntitiesAsync(GetRelatedEntitiesRequest) - Method in interface com.loop54.ILoop54Client
- getRelatedEntitiesAsync(GetRelatedEntitiesRequest) - Method in class com.loop54.Loop54Client
- getRelatedEntitiesAsync(RequestContainer<GetRelatedEntitiesRequest>) - Method in interface com.loop54.ILoop54Client
- getRelatedEntitiesAsync(RequestContainer<GetRelatedEntitiesRequest>) - Method in class com.loop54.Loop54Client
- GetRelatedEntitiesRequest - Class in com.loop54.model.request
-
This class is used to configure a GetEntities request to the Loop54 e-commerce search engine.
- GetRelatedEntitiesRequest(Entity) - Constructor for class com.loop54.model.request.GetRelatedEntitiesRequest
- GetRelatedEntitiesRequest(String, String) - Constructor for class com.loop54.model.request.GetRelatedEntitiesRequest
- GetRelatedEntitiesResponse - Class in com.loop54.model.response
-
The result of a getRelatedEntities request.
- GetRelatedEntitiesResponse() - Constructor for class com.loop54.model.response.GetRelatedEntitiesResponse
- getRemoteClientInfo() - Method in interface com.loop54.user.IRemoteClientInfoProvider
-
Creates and returns a
IRemoteClientInfothat contains information of the current, calling end-user (headers, cookies etc) - getRemoteIp() - Method in interface com.loop54.user.IRemoteClientInfo
-
Get the IP address of the end-user.
- getRemoteIp() - Method in class com.loop54.user.NullClientInfo
- getRequestContainer(T) - Static method in class com.loop54.Loop54Client
- getRequestContainer(T, UserMetaData) - Static method in class com.loop54.Loop54Client
-
Will wrap the request in a requestContainer to provide overriding options for the API call.
- getRequestHeader(String) - Method in interface com.loop54.user.IRemoteClientInfo
-
Get a named header from the request made by the end-user.
- getRequestHeader(String) - Method in class com.loop54.user.NullClientInfo
- getRequestManager() - Method in class com.loop54.Loop54Client
- getRequestTimeoutMs() - Method in class com.loop54.Loop54Settings
- getRequireHttps() - Method in class com.loop54.Loop54Settings
- getSelectedMax(Class<T>) - Method in class com.loop54.model.response.RangeFacet
-
Gets the minimum selected value of the facet, as provided in the request.
- getSelectedMin(Class<T>) - Method in class com.loop54.model.response.RangeFacet
-
Gets the minimum selected value of the facet, as provided in the request.
- getSettings() - Method in class com.loop54.http.RequestManager
- getSingleOrThrow() - Method in class com.loop54.Loop54ClientProvider
- getType() - Method in class com.loop54.model.EntityAttribute
- getType() - Method in class com.loop54.model.request.parameters.facets.DistinctFacetParameter
- getType() - Method in class com.loop54.model.request.parameters.facets.FacetParameter
-
Type of the facet.
- getType() - Method in class com.loop54.model.request.parameters.facets.RangeFacetParameter
- getType() - Method in class com.loop54.model.response.DistinctFacet
-
The type of the facet (as set in the request).
- getType() - Method in class com.loop54.model.response.Facet
-
The type of the facet (as set in the request).
- getType() - Method in class com.loop54.model.response.RangeFacet
-
The type of the facet (as set in the request).
- getUserAgent() - Method in interface com.loop54.user.IRemoteClientInfo
-
Get the User-Agent header sent by the end-user.
- getUserAgent() - Method in class com.loop54.user.NullClientInfo
- getValue(Class<T>) - Method in class com.loop54.model.EntityAttribute
-
Casts the first value to the specified generic type and returns it, or null if there are no values.
- getValues(Class<T>) - Method in class com.loop54.model.EntityAttribute
-
Casts the values to the specified generic type and return them all as a list.
- GREATER_THAN - Enum constant in enum class com.loop54.model.request.parameters.filters.FilterComparisonMode
- GREATER_THAN_OR_EQUALS - Enum constant in enum class com.loop54.model.request.parameters.filters.FilterComparisonMode
H
- hasValues() - Method in class com.loop54.model.response.DistinctFacet
-
Whether or not the facet has any options.
- hasValues() - Method in class com.loop54.model.response.Facet
-
Whether or not the facet have any options.
- hasValues() - Method in class com.loop54.model.response.RangeFacet
-
Whether or not the facet has any options.
- headers - Variable in class com.loop54.user.NullClientInfo
- Headers - Class in com.loop54.http
-
Headers used by v3 of the Loop54 api.
- Headers() - Constructor for class com.loop54.http.Headers
I
- id - Variable in class com.loop54.model.Entity
-
The unique id of the entity.
- ID - Enum constant in enum class com.loop54.model.request.parameters.EntitySortingParameter.Types
-
Sort the entities by id.
- ID - Enum constant in enum class com.loop54.model.request.parameters.filters.FilterParameterType
-
Compares against the id of the entity
- ILoop54Client - Interface in com.loop54
- ILoop54ClientProvider - Interface in com.loop54
-
Interface for handling multiple instances of
ILoop54Clientwithin the same application. - INTEGER - Enum constant in enum class com.loop54.model.EntityAttributeType
- InverseFilterParameter - Class in com.loop54.model.request.parameters.filters
-
Used for inverting a filter.
- InverseFilterParameter(FilterParameter) - Constructor for class com.loop54.model.request.parameters.filters.InverseFilterParameter
- IP_ADDRESS - Static variable in class com.loop54.http.Headers
- ipAddress - Variable in class com.loop54.user.UserMetaData
-
Ip address of the end-user.
- IRemoteClientInfo - Interface in com.loop54.user
-
This interface contains methods used to get information about the end-user client request.
- IRemoteClientInfoProvider - Interface in com.loop54.user
-
An interface for creating
IRemoteClientInfo. - IRequestManager - Interface in com.loop54.http
-
Handles the HTTP request to the Loop54 API.
- item - Variable in class com.loop54.model.response.DistinctFacet.DistinctFacetItem
- ITEM - Enum constant in enum class com.loop54.model.request.parameters.facets.DistinctFacetItemSortingParameter.Types
- items - Variable in class com.loop54.model.response.EntityCollection
-
The filtered, faceted, sorted and paged entities.
- items - Variable in class com.loop54.model.response.QueryCollection
-
The queries after paging.
- iterator() - Method in class com.loop54.Loop54SettingsCollection
L
- LESS_THAN - Enum constant in enum class com.loop54.model.request.parameters.filters.FilterComparisonMode
- LESS_THAN_OR_EQUALS - Enum constant in enum class com.loop54.model.request.parameters.filters.FilterComparisonMode
- LIB_VERSION - Static variable in class com.loop54.VersionHeaders
- LIB_VERSION_HEADER - Static variable in class com.loop54.VersionHeaders
- Loop54ArgumentException - Exception in com.loop54.exceptions
-
Runtime exception thrown when an illegal/missing argument is detected.
- Loop54ArgumentException(String) - Constructor for exception com.loop54.exceptions.Loop54ArgumentException
- Loop54Client - Class in com.loop54
-
Default implementation of the ILoop54Client interface.
- Loop54Client(IRequestManager, IRemoteClientInfoProvider) - Constructor for class com.loop54.Loop54Client
- Loop54ClientProvider - Class in com.loop54
-
Class for handling multiple instances of ILoop54Client.
- Loop54ClientProvider(IRemoteClientInfoProvider, Loop54SettingsCollection) - Constructor for class com.loop54.Loop54ClientProvider
- Loop54Exception - Exception in com.loop54.exceptions
-
Base class for all Loop54-specific checked exceptions.
- Loop54Exception(Exception) - Constructor for exception com.loop54.exceptions.Loop54Exception
- Loop54Exception(String) - Constructor for exception com.loop54.exceptions.Loop54Exception
- Loop54Exception(String, Exception) - Constructor for exception com.loop54.exceptions.Loop54Exception
- Loop54RuntimeException - Exception in com.loop54.exceptions
-
Base class for all Loop54-specific unchecked exceptions.
- Loop54RuntimeException(Exception) - Constructor for exception com.loop54.exceptions.Loop54RuntimeException
- Loop54RuntimeException(String) - Constructor for exception com.loop54.exceptions.Loop54RuntimeException
- Loop54RuntimeException(String, Exception) - Constructor for exception com.loop54.exceptions.Loop54RuntimeException
- Loop54Settings - Class in com.loop54
-
Global settings for the Loop54 e-commerce search engine setup.
- Loop54Settings(String, String) - Constructor for class com.loop54.Loop54Settings
-
Forwards to
Loop54Settings(String, String, boolean, int), with HTTPS enabled, and a request timeout of 10 seconds. - Loop54Settings(String, String, boolean, int) - Constructor for class com.loop54.Loop54Settings
- Loop54SettingsCollection - Class in com.loop54
-
Class containing a named settings for the Loop54 search engine library.
M
- makesSense - Variable in class com.loop54.model.response.SearchResponse
-
Whether or not the engine understood the search query.
- MAPPER - Static variable in class com.loop54.serialization.Serializer
- max - Variable in class com.loop54.model.request.parameters.facets.RangeFacetParameter.RangeFacetSelectedParameter
-
Selected maximum.
- max - Variable in class com.loop54.model.response.RangeFacet
- metaDataOverrides - Variable in class com.loop54.RequestContainer
-
Overrides for client meta data.
- min - Variable in class com.loop54.model.request.parameters.facets.RangeFacetParameter.RangeFacetSelectedParameter
-
Selected minimum.
- min - Variable in class com.loop54.model.response.RangeFacet
- ModelUtils - Class in com.loop54.model
- ModelUtils() - Constructor for class com.loop54.model.ModelUtils
N
- name - Variable in class com.loop54.model.request.AttributeNameValuePair
-
Name of the attribute.
- name - Variable in class com.loop54.model.request.parameters.facets.FacetParameter
-
Name of the facet to return to the client.
- name - Variable in class com.loop54.model.request.RequestAliasData
-
Specify an alias for this attribute name.
- name - Variable in class com.loop54.model.response.Facet
- not - Variable in class com.loop54.model.request.parameters.filters.InverseFilterParameter
-
The filter that should be inversed.
- NullClientInfo - Class in com.loop54.user
- NullClientInfo() - Constructor for class com.loop54.user.NullClientInfo
- NUMBER - Enum constant in enum class com.loop54.model.EntityAttributeType
- numberSafeCast(Object, Class<T>) - Static method in class com.loop54.model.ModelUtils
O
- OBJECT - Enum constant in enum class com.loop54.model.EntityAttributeType
- or - Variable in class com.loop54.model.request.parameters.filters.OrFilterParameter
-
The filters that should be combined.
- order - Variable in class com.loop54.model.request.parameters.EntitySortingParameter
-
In what order to sort the entities.
- order - Variable in class com.loop54.model.request.parameters.facets.DistinctFacetItemSortingParameter
-
Whether to sort items descending or ascending.
- order - Variable in class com.loop54.model.request.parameters.QuerySortingParameter
-
In what order to sort the queries.
- orderId - Variable in class com.loop54.model.request.parameters.PurchaseEvent
-
An identifier of the purchase order.
- OrFilterParameter - Class in com.loop54.model.request.parameters.filters
-
Used for combining two or more filters using or logic
- OrFilterParameter() - Constructor for class com.loop54.model.request.parameters.filters.OrFilterParameter
- OrFilterParameter(FilterParameter...) - Constructor for class com.loop54.model.request.parameters.filters.OrFilterParameter
P
- parameter - Variable in class com.loop54.model.response.ErrorDetails
-
The input parameter, if any, that caused the error.
- POPULARITY - Enum constant in enum class com.loop54.model.request.parameters.EntitySortingParameter.Types
-
Sort the entities by their popularity.
- POPULARITY - Enum constant in enum class com.loop54.model.request.parameters.QuerySortingParameter.Types
- PROXY_IP_HEADER_NAME - Static variable in class com.loop54.user.UserMetaData
- PURCHASE - Static variable in class com.loop54.model.request.parameters.Event
-
The string value corresponding to the purchase-event
- PurchaseEvent - Class in com.loop54.model.request.parameters
-
Event for when a user has purchased a product.
- PurchaseEvent(Entity) - Constructor for class com.loop54.model.request.parameters.PurchaseEvent
Q
- quantity - Variable in class com.loop54.model.request.parameters.PurchaseEvent
-
How many items of the entity that has been purchased.
- queries - Variable in class com.loop54.model.response.AutoCompleteResponse
-
A collection of query suggestions for the request query.
- queriesOptions - Variable in class com.loop54.model.request.AutoCompleteRequest
-
Parameters for specifying how the auto-complete results should be retrieved.
- query - Variable in class com.loop54.model.request.AutoCompleteRequest
-
The partial query that the user has entered.
- query - Variable in class com.loop54.model.request.SearchRequest
-
The search query from the end-user.
- query - Variable in class com.loop54.model.response.QueryResult
-
The query.
- QueryCollection - Class in com.loop54.model.response
-
A collection of queries (strings).
- QueryCollection() - Constructor for class com.loop54.model.response.QueryCollection
- QueryCollectionParameters - Class in com.loop54.model.request.parameters
-
This class is used to specify which queries to get in a request.
- QueryCollectionParameters() - Constructor for class com.loop54.model.request.parameters.QueryCollectionParameters
- QueryResult - Class in com.loop54.model.response
-
An instance of a query.
- QueryResult() - Constructor for class com.loop54.model.response.QueryResult
- QuerySortingParameter - Class in com.loop54.model.request.parameters
-
This class specifies how queries should be sorted when making a request.
- QuerySortingParameter() - Constructor for class com.loop54.model.request.parameters.QuerySortingParameter
- QuerySortingParameter(QuerySortingParameter.Types) - Constructor for class com.loop54.model.request.parameters.QuerySortingParameter
- QuerySortingParameter(QuerySortingParameter.Types, SortOrders) - Constructor for class com.loop54.model.request.parameters.QuerySortingParameter
- QuerySortingParameter.Types - Enum Class in com.loop54.model.request.parameters
-
The types of sorting available when sorting queries.
R
- RANGE - Enum constant in enum class com.loop54.model.FacetType
-
A facet that has a min and max value and only entities in between them are returned.
- RangeFacet - Class in com.loop54.model.response
-
This class provides results for a range facet.
- RangeFacet() - Constructor for class com.loop54.model.response.RangeFacet
- RangeFacetParameter<T> - Class in com.loop54.model.request.parameters.facets
- RangeFacetParameter(String, RangeFacetParameter.RangeFacetSelectedParameter<T>, String) - Constructor for class com.loop54.model.request.parameters.facets.RangeFacetParameter
- RangeFacetParameter.RangeFacetSelectedParameter<T> - Class in com.loop54.model.request.parameters.facets
-
The selected min and max for the facet.
- RangeFacetSelectedParameter() - Constructor for class com.loop54.model.request.parameters.facets.RangeFacetParameter.RangeFacetSelectedParameter
- referer - Variable in class com.loop54.user.UserMetaData
-
The Referer(sic) header from the end-user.
- REFERER - Static variable in class com.loop54.http.Headers
- relatedQueries - Variable in class com.loop54.model.response.SearchResponse
-
A collection of suggestions for queries that are related to the provided query.
- relatedQueriesOptions - Variable in class com.loop54.model.request.SearchRequest
-
Parameters for specifying how related queries should be retrieved.
- relatedResults - Variable in class com.loop54.model.response.SearchResponse
-
Any additional results that, while not matching, are relevant to the query.
- relatedResultsOptions - Variable in class com.loop54.model.request.SearchRequest
-
Parameters for specifying which related results to retrieve.
- RELEVANCE - Enum constant in enum class com.loop54.model.request.parameters.EntitySortingParameter.Types
-
Sort the entities by their relevance.
- RELEVANCE - Enum constant in enum class com.loop54.model.request.parameters.QuerySortingParameter.Types
- request - Variable in class com.loop54.RequestContainer
-
Contains the request data to send to the engine.
- Request - Class in com.loop54.model.request
-
The base request class used for issuing custom requests to the Loop54 e-commerce search engine.
- Request() - Constructor for class com.loop54.model.request.Request
- requestAlias - Variable in class com.loop54.model.request.GetEntitiesByAttributeRequest
-
Provides human-readable labels in the Portal.
- RequestAliasData - Class in com.loop54.model.request
-
Provides human-readable labels in the Portal.
- RequestAliasData() - Constructor for class com.loop54.model.request.RequestAliasData
- RequestContainer<T extends Request> - Class in com.loop54
-
This class wraps a request object together with options for the API call.
- RequestContainer(T, UserMetaData) - Constructor for class com.loop54.RequestContainer
- RequestManager - Class in com.loop54.http
-
Handles the request to the Loop54 API.
- RequestManager(Loop54Settings) - Constructor for class com.loop54.http.RequestManager
- Response - Class in com.loop54.model.response
-
A response from the engine.
- Response() - Constructor for class com.loop54.model.response.Response
- results - Variable in class com.loop54.model.response.GetBasketRecommendationsResponse
-
The recommended entities
- results - Variable in class com.loop54.model.response.GetComplementaryEntitiesResponse
-
The entities that are complementary to the entity supplied in the request.
- results - Variable in class com.loop54.model.response.GetEntitiesByAttributeResponse
-
The entities that are connected to the attribute.
- results - Variable in class com.loop54.model.response.GetEntitiesResponse
-
The entities returned in the request.
- results - Variable in class com.loop54.model.response.GetPopularEntitiesResponse
-
The entities returned in the request.
- results - Variable in class com.loop54.model.response.GetRecentEntitiesResponse
-
The entities returned in the request.
- results - Variable in class com.loop54.model.response.GetRecommendedEntitiesResponse
-
The personalized recommended entities.
- results - Variable in class com.loop54.model.response.GetRelatedEntitiesResponse
-
The entities that are related to the entity supplied in the request.
- results - Variable in class com.loop54.model.response.SearchResponse
-
The results that match the query.
- resultsOptions - Variable in class com.loop54.model.request.GetBasketRecommendationsRequest
-
Parameters for specifying which entities to retrieve.
- resultsOptions - Variable in class com.loop54.model.request.GetComplementaryEntitiesRequest
-
Parameters for specifying which entities to retrieve.
- resultsOptions - Variable in class com.loop54.model.request.GetEntitiesByAttributeRequest
-
Parameters for specifying which entities to retrieve.
- resultsOptions - Variable in class com.loop54.model.request.GetEntitiesRequest
-
Parameters for specifying which entities to retrieve.
- resultsOptions - Variable in class com.loop54.model.request.GetPopularOrRecentEntitiesRequest
-
Parameters for specifying which recommendations results to retrieve and how to format them.
- resultsOptions - Variable in class com.loop54.model.request.GetRecommendedEntitiesRequest
-
Parameters for specifying which recommendations results to retrieve and how to format them.
- resultsOptions - Variable in class com.loop54.model.request.GetRelatedEntitiesRequest
-
Parameters for specifying which entities to retrieve.
- resultsOptions - Variable in class com.loop54.model.request.SearchRequest
-
Parameters for specifying which direct results to retrieve.
- revenue - Variable in class com.loop54.model.request.parameters.PurchaseEvent
-
How much revenue the purchase may have resulted in.
S
- scopeAttributeName - Variable in class com.loop54.model.response.ScopedQueryResult
-
The name of the attribute from which the scopes were created
- scopedQuery - Variable in class com.loop54.model.response.AutoCompleteResponse
-
The query that the engine considered most relevant, will get a result with scopes.
- ScopedQueryResult - Class in com.loop54.model.response
-
A query with scopes.
- ScopedQueryResult() - Constructor for class com.loop54.model.response.ScopedQueryResult
- scopes - Variable in class com.loop54.model.response.ScopedQueryResult
-
Scopes where this query is relevant.
- search(SearchRequest) - Method in interface com.loop54.ILoop54Client
- search(SearchRequest) - Method in class com.loop54.Loop54Client
- search(RequestContainer<SearchRequest>) - Method in interface com.loop54.ILoop54Client
- search(RequestContainer<SearchRequest>) - Method in class com.loop54.Loop54Client
- searchAsync(SearchRequest) - Method in interface com.loop54.ILoop54Client
- searchAsync(SearchRequest) - Method in class com.loop54.Loop54Client
- searchAsync(RequestContainer<SearchRequest>) - Method in interface com.loop54.ILoop54Client
- searchAsync(RequestContainer<SearchRequest>) - Method in class com.loop54.Loop54Client
- SearchRequest - Class in com.loop54.model.request
-
This class is used to configure a search request to the Loop54 e-commerce search engine.
- SearchRequest(String) - Constructor for class com.loop54.model.request.SearchRequest
-
The search query from the end-user.
- SearchResponse - Class in com.loop54.model.response
-
The result of a search operation.
- SearchResponse() - Constructor for class com.loop54.model.response.SearchResponse
- selected - Variable in class com.loop54.model.request.parameters.facets.DistinctFacetParameter
-
What options the user has selected.
- selected - Variable in class com.loop54.model.request.parameters.facets.RangeFacetParameter
-
The min and max values selected by the user.
- selected - Variable in class com.loop54.model.response.DistinctFacet.DistinctFacetItem
-
Whether or not this option was marked selected in the request.
- SELECTED - Enum constant in enum class com.loop54.model.request.parameters.facets.DistinctFacetItemSortingParameter.Types
- selectedMax - Variable in class com.loop54.model.response.RangeFacet
- selectedMin - Variable in class com.loop54.model.response.RangeFacet
- SerializationException - Exception in com.loop54.exceptions
-
Thrown when the data returned from the engine could not be serialized or deserialize.
- SerializationException(String, Exception) - Constructor for exception com.loop54.exceptions.SerializationException
- serialize(Object) - Static method in class com.loop54.serialization.Serializer
- Serializer - Class in com.loop54.serialization
- Serializer() - Constructor for class com.loop54.serialization.Serializer
- setAttributes(List<EntityAttribute>) - Method in class com.loop54.model.Entity
- setCookie(String, String, LocalDateTime) - Method in interface com.loop54.user.IRemoteClientInfo
-
Sets a cookie with a given name, value and expiryTime.
- setCookie(String, String, LocalDateTime) - Method in class com.loop54.user.NullClientInfo
- setFromClientInfo(IRemoteClientInfo) - Method in class com.loop54.user.UserMetaData
- size() - Method in class com.loop54.Loop54SettingsCollection
- skip - Variable in class com.loop54.model.request.parameters.EntityCollectionParameters
-
How many entities to skip when paging the result.
- skip - Variable in class com.loop54.model.request.parameters.QueryCollectionParameters
-
How many queries to skip.
- sortBy - Variable in class com.loop54.model.request.parameters.EntityCollectionParameters
-
List of sorting parameters specifying how the result should be sorted.
- sortBy - Variable in class com.loop54.model.request.parameters.facets.DistinctFacetParameter
-
These sorting parameters specify how the options are to be sorted in the response.
- sortBy - Variable in class com.loop54.model.request.parameters.QueryCollectionParameters
-
How to sort the queries.
- SortOrders - Enum Class in com.loop54.model.request.parameters
- spellingSuggestions - Variable in class com.loop54.model.response.SearchResponse
-
A collection of suggestions for alternate spellings of the query.
- spellingSuggestionsOptions - Variable in class com.loop54.model.request.SearchRequest
-
Parameters for specifying how spelling suggestions should be retrieved.
- status - Variable in class com.loop54.model.response.ErrorDetails
-
The HTTP status code of the response.
- STRING - Enum constant in enum class com.loop54.model.EntityAttributeType
- sync() - Method in interface com.loop54.ILoop54Client
- sync() - Method in class com.loop54.Loop54Client
- sync(Request) - Method in interface com.loop54.ILoop54Client
- sync(Request) - Method in class com.loop54.Loop54Client
- sync(RequestContainer<Request>) - Method in interface com.loop54.ILoop54Client
- sync(RequestContainer<Request>) - Method in class com.loop54.Loop54Client
- syncAsync() - Method in interface com.loop54.ILoop54Client
- syncAsync() - Method in class com.loop54.Loop54Client
- syncAsync(Request) - Method in interface com.loop54.ILoop54Client
- syncAsync(Request) - Method in class com.loop54.Loop54Client
- syncAsync(RequestContainer<Request>) - Method in interface com.loop54.ILoop54Client
- syncAsync(RequestContainer<Request>) - Method in class com.loop54.Loop54Client
T
- take - Variable in class com.loop54.model.request.parameters.EntityCollectionParameters
-
How many entities to take when paging the result.
- take - Variable in class com.loop54.model.request.parameters.QueryCollectionParameters
-
How many queries to take.
- title - Variable in class com.loop54.model.response.ErrorDetails
-
The name of the error.
- type - Variable in class com.loop54.model.Entity
-
The type of the entity.
- type - Variable in class com.loop54.model.request.parameters.EntitySortingParameter
-
How the entities should be sorted.
- type - Variable in class com.loop54.model.request.parameters.Event
-
Type of the event.
- type - Variable in class com.loop54.model.request.parameters.facets.DistinctFacetItemSortingParameter
-
How the sorting is done.
- type - Variable in class com.loop54.model.request.parameters.filters.AttributeFilterParameter
-
Type of the filter.
- type - Variable in class com.loop54.model.request.parameters.QuerySortingParameter
-
How the queries should be sorted.
- TYPE - Enum constant in enum class com.loop54.model.request.parameters.EntitySortingParameter.Types
-
Sort the entities by type.
- TYPE - Enum constant in enum class com.loop54.model.request.parameters.filters.FilterParameterType
-
Compares against the type of the entity
U
- urlIsHttps(String) - Static method in class com.loop54.Utils
-
Checks whether an URL is using HTTPS.
- USER_AGENT - Static variable in class com.loop54.http.Headers
- USER_ID - Static variable in class com.loop54.http.Headers
- USER_ID_COOKIE_KEY - Static variable in class com.loop54.user.UserMetaData
- userAgent - Variable in class com.loop54.user.UserMetaData
-
User-Agent header from the end-user.
- userId - Variable in class com.loop54.user.UserMetaData
-
An unique identifier of the end-user.
- UserMetaData - Class in com.loop54.user
-
Represents data about the end-user.
- UserMetaData() - Constructor for class com.loop54.user.UserMetaData
- UserMetaData(String) - Constructor for class com.loop54.user.UserMetaData
-
The unique id of the user.
- Utils - Class in com.loop54
- Utils() - Constructor for class com.loop54.Utils
V
- value - Variable in class com.loop54.model.request.AttributeNameValuePairMulti
-
Value to filter by.
- value - Variable in class com.loop54.model.request.AttributeNameValuePairSingle
-
Value to filter by.
- value - Variable in class com.loop54.model.request.parameters.filters.AttributeFilterParameter
-
The value to test the attributes values against.
- value - Variable in class com.loop54.model.request.RequestAliasData
-
Specify an alias for this attribute value.
- valueOf(String) - Static method in enum class com.loop54.model.EntityAttributeType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.loop54.model.FacetType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.loop54.model.request.parameters.EntitySortingParameter.Types
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.loop54.model.request.parameters.facets.DistinctFacetItemSortingParameter.Types
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.loop54.model.request.parameters.filters.FilterComparisonMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.loop54.model.request.parameters.filters.FilterParameterType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.loop54.model.request.parameters.QuerySortingParameter.Types
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.loop54.model.request.parameters.SortOrders
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.loop54.model.EntityAttributeType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.loop54.model.FacetType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.loop54.model.request.parameters.EntitySortingParameter.Types
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.loop54.model.request.parameters.facets.DistinctFacetItemSortingParameter.Types
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.loop54.model.request.parameters.filters.FilterComparisonMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.loop54.model.request.parameters.filters.FilterParameterType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.loop54.model.request.parameters.QuerySortingParameter.Types
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.loop54.model.request.parameters.SortOrders
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VersionHeaders - Class in com.loop54
- VersionHeaders() - Constructor for class com.loop54.VersionHeaders
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form