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 and Description
AttributeNameValuePair	attribute The attribute name-value-pair to find entities connected to.
RequestAliasData	requestAlias Provides human-readable labels in the Portal.
EntityCollectionParameters	resultsOptions Parameters for specifying which entities to retrieve.

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

customData

Constructor Summary

Constructors

Constructor and Description
GetEntitiesByAttributeRequest(java.lang.String attributeName, java.lang.String attributeValue)
GetEntitiesByAttributeRequest(java.lang.String attributeName, java.lang.String[] attributeValues)
GetEntitiesByAttributeRequest(java.lang.String attributeName, java.lang.String[] attributeValues, RequestAliasData requestAlias)
GetEntitiesByAttributeRequest(java.lang.String attributeName, java.lang.String attributeValue, RequestAliasData requestAlias)

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

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 Detail

GetEntitiesByAttributeRequest

public GetEntitiesByAttributeRequest(java.lang.String attributeName,
                                     java.lang.String attributeValue,
                                     RequestAliasData requestAlias)

GetEntitiesByAttributeRequest

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

GetEntitiesByAttributeRequest

public GetEntitiesByAttributeRequest(java.lang.String attributeName,
                                     java.lang.String attributeValue)

GetEntitiesByAttributeRequest

public GetEntitiesByAttributeRequest(java.lang.String attributeName,
                                     java.lang.String[] attributeValues)