Package com.loop54.model.request

Class GetRelatedEntitiesRequest

java.lang.Object

com.loop54.model.request.Request

com.loop54.model.request.GetRelatedEntitiesRequest

public class GetRelatedEntitiesRequest
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
Entity	entity	The entity who's related entities we want to get.
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
GetRelatedEntitiesRequest(Entity entity)
GetRelatedEntitiesRequest(String entityType, String entityId)

Method Summary

Modifier and Type	Method	Description
GetRelatedEntitiesRequest	withCustomData(String key, Object value)	Chainable variant of Request.addCustomData(String, Object).
GetRelatedEntitiesRequest	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

entity

public Entity entity

The entity who's related entities we want to get. Only needs the type and id set.

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

GetRelatedEntitiesRequest

public GetRelatedEntitiesRequest(String entityType,
 String entityId)

Parameters:

entityType - Type of the entity to query

entityId - Id of the entity to query

GetRelatedEntitiesRequest

public GetRelatedEntitiesRequest(Entity entity)

Parameters:

entity - The entity to use in the query.

Method Details

withResults

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