Package com.loop54.model.request

Class ContentRequest

java.lang.Object

com.loop54.model.request.Request

com.loop54.model.request.ContentRequest

Direct Known Subclasses:

SearchRequest

public abstract class ContentRequest
extends Request

Base class for requests that can also retrieve Content Search results.

Field Summary

Fields

Modifier and Type	Field	Description
List<TypedEntityCollectionParameters>	contentResultsOptions	Parameters for specifying which content results to retrieve (Content Search).

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

customData

Constructor Summary

Constructors

Constructor	Description
ContentRequest()

Method Summary

Modifier and Type	Method	Description
TypedEntityCollectionParameters	addContentResultsOptions(String entityType)	Adds a content entity type to search and returns its parameters, so that paging, sorting, faceting and filtering can be set on it.

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

contentResultsOptions

public List<TypedEntityCollectionParameters> contentResultsOptions

Parameters for specifying which content results to retrieve (Content Search). One entry per content entity type, e.g. "Brand" or "Article", each with its own paging, sorting, faceting and filtering. If not set, no content is searched. Does not affect the product results.

Constructor Details

ContentRequest

public ContentRequest()

Method Details

addContentResultsOptions

public TypedEntityCollectionParameters addContentResultsOptions(String entityType)

Adds a content entity type to search and returns its parameters, so that paging, sorting, faceting and filtering can be set on it. If parameters for that entity type were already added, the existing parameters are returned instead of adding a duplicate.

Parameters:

entityType - The content entity type to search, e.g. "Brand". Case-sensitive.

Returns:

The parameters for the added content entity type.