Package com.loop54.model.request

Class GetEntitiesByAttributeRequest

java.lang.Object

com.loop54.model.request.Request

com.loop54.model.request.GetEntitiesByAttributeRequest

public class GetEntitiesByAttributeRequest
extends Request

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

Field Summary

Fields

Modifier and Type	Field	Description
AttributeNameValuePair	attribute	The attribute name-value-pair to find entities connected to.
RequestAliasData	requestAlias	Provides human-readable labels in the Portal.
final EntityCollectionParameters	resultsOptions	Parameters for specifying which entities to retrieve.

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

customData

Constructor Summary

Constructors

Constructor	Description
GetEntitiesByAttributeRequest(String attributeName, String attributeValue)
GetEntitiesByAttributeRequest(String attributeName, String[] attributeValues)
GetEntitiesByAttributeRequest(String attributeName, String[] attributeValues, RequestAliasData requestAlias)
GetEntitiesByAttributeRequest(String attributeName, String attributeValue, RequestAliasData requestAlias)

Method Summary

Modifier and Type	Method	Description
GetEntitiesByAttributeRequest	withCustomData(String key, Object value)	Chainable variant of Request.addCustomData(String, Object).
GetEntitiesByAttributeRequest	withRequestAlias(RequestAliasData requestAlias)	Sets the human-readable labels shown in the Portal.
GetEntitiesByAttributeRequest	withResults(Consumer<EntityCollectionParameters> configurator)	Configures resultsOptions, 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

attribute

public AttributeNameValuePair attribute

The attribute name-value-pair to find entities connected to. Note: this attribute needs to be indexed in the engine. See the endpoint GetIndexedAttribute.

requestAlias

public RequestAliasData requestAlias

Provides human-readable labels in the Portal.

resultsOptions

public final EntityCollectionParameters resultsOptions

Parameters for specifying which entities to retrieve. Such as filtering, faceting, sorting and paging. Note that filtering is advised when doing this request.

Constructor Details

GetEntitiesByAttributeRequest

public GetEntitiesByAttributeRequest(String attributeName,
 String attributeValue,
 RequestAliasData requestAlias)

GetEntitiesByAttributeRequest

public GetEntitiesByAttributeRequest(String attributeName,
 String[] attributeValues,
 RequestAliasData requestAlias)

GetEntitiesByAttributeRequest

public GetEntitiesByAttributeRequest(String attributeName,
 String attributeValue)

GetEntitiesByAttributeRequest

public GetEntitiesByAttributeRequest(String attributeName,
 String[] attributeValues)

Method Details

withRequestAlias

public GetEntitiesByAttributeRequest withRequestAlias(RequestAliasData requestAlias)

Sets the human-readable labels shown in the Portal.

Parameters:

requestAlias - The alias data to use.

Returns:

This request, for chaining.

withResults

public GetEntitiesByAttributeRequest withResults(Consumer<EntityCollectionParameters> configurator)

Configures resultsOptions, e.g. request.withResults(r -> r.page(0, 20).distinctFacet("Category")).

Parameters:

configurator - Applied to resultsOptions.

Returns:

This request, for chaining.

withCustomData

public GetEntitiesByAttributeRequest 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.