Package de.codebarista.shopware.model.core

Class ProductListingResult

java.lang.Object

de.codebarista.shopware.model.core.ProductListingResult

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-06-10T11:26:02.541008353+02:00[Europe/Berlin]",
           comments="Generator version: 7.5.0")
public class ProductListingResult
extends Object

ProductListingResult

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_AGGREGATIONS
static final String	JSON_PROPERTY_API_ALIAS
static final String	JSON_PROPERTY_AVAILABLE_SORTINGS
static final String	JSON_PROPERTY_CURRENT_FILTERS
static final String	JSON_PROPERTY_ELEMENTS
static final String	JSON_PROPERTY_ENTITY
static final String	JSON_PROPERTY_LIMIT
static final String	JSON_PROPERTY_PAGE
static final String	JSON_PROPERTY_SORTING
static final String	JSON_PROPERTY_TOTAL

Constructor Summary

Constructors

Constructor	Description
ProductListingResult()

Method Summary

Modifier and Type	Method	Description
ProductListingResult	addAggregationsItem(Object aggregationsItem)
ProductListingResult	addAvailableSortingsItem(Object availableSortingsItem)
ProductListingResult	addElementsItem(Product elementsItem)
ProductListingResult	aggregations(List<Object> aggregations)
ProductListingResult	apiAlias(String apiAlias)
ProductListingResult	availableSortings(List<Object> availableSortings)
ProductListingResult	currentFilters(ProductListingResultAllOfCurrentFilters currentFilters)
ProductListingResult	elements(List<Product> elements)
ProductListingResult	entity(String entity)
boolean	equals(Object o)
List<Object>	getAggregations()	Contains aggregated data.
String	getApiAlias()	Alias which can be used to restrict response fields.
List<Object>	getAvailableSortings()	Contains the available sorting.
ProductListingResultAllOfCurrentFilters	getCurrentFilters()	Get currentFilters
List<Product>	getElements()	Get elements
String	getEntity()	Get entity
Integer	getLimit()	The actual limit.
Integer	getPage()	The actual page.
String	getSorting()	Get sorting
Integer	getTotal()	The total number of found entities
int	hashCode()
ProductListingResult	limit(Integer limit)
ProductListingResult	page(Integer page)
void	setAggregations(List<Object> aggregations)
void	setApiAlias(String apiAlias)
void	setAvailableSortings(List<Object> availableSortings)
void	setCurrentFilters(ProductListingResultAllOfCurrentFilters currentFilters)
void	setElements(List<Product> elements)
void	setEntity(String entity)
void	setLimit(Integer limit)
void	setPage(Integer page)
void	setSorting(String sorting)
void	setTotal(Integer total)
ProductListingResult	sorting(String sorting)
String	toString()
ProductListingResult	total(Integer total)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_API_ALIAS

public static final String JSON_PROPERTY_API_ALIAS

See Also:

• Constant Field Values

JSON_PROPERTY_ENTITY

public static final String JSON_PROPERTY_ENTITY

See Also:

• Constant Field Values

JSON_PROPERTY_TOTAL

public static final String JSON_PROPERTY_TOTAL

See Also:

• Constant Field Values

JSON_PROPERTY_AGGREGATIONS

public static final String JSON_PROPERTY_AGGREGATIONS

See Also:

• Constant Field Values

JSON_PROPERTY_PAGE

public static final String JSON_PROPERTY_PAGE

See Also:

• Constant Field Values

JSON_PROPERTY_LIMIT

public static final String JSON_PROPERTY_LIMIT

See Also:

• Constant Field Values

JSON_PROPERTY_CURRENT_FILTERS

public static final String JSON_PROPERTY_CURRENT_FILTERS

See Also:

• Constant Field Values

JSON_PROPERTY_AVAILABLE_SORTINGS

public static final String JSON_PROPERTY_AVAILABLE_SORTINGS

See Also:

• Constant Field Values

JSON_PROPERTY_SORTING

public static final String JSON_PROPERTY_SORTING

See Also:

• Constant Field Values

JSON_PROPERTY_ELEMENTS

public static final String JSON_PROPERTY_ELEMENTS

See Also:

• Constant Field Values

Constructor Details

ProductListingResult

public ProductListingResult()

Method Details

apiAlias

public ProductListingResult apiAlias(String apiAlias)

getApiAlias

@Nullable
public String getApiAlias()

Alias which can be used to restrict response fields. For more information see [includes](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#includes-apialias).

Returns:

apiAlias

setApiAlias

public void setApiAlias(String apiAlias)

entity

public ProductListingResult entity(String entity)

getEntity

@Nullable
public String getEntity()

Get entity

Returns:

entity

setEntity

public void setEntity(String entity)

total

public ProductListingResult total(Integer total)

getTotal

@Nullable
public Integer getTotal()

The total number of found entities

Returns:

total

setTotal

public void setTotal(Integer total)

aggregations

public ProductListingResult aggregations(List<Object> aggregations)

addAggregationsItem

public ProductListingResult addAggregationsItem(Object aggregationsItem)

getAggregations

@Nullable
public List<Object> getAggregations()

Contains aggregated data. A simple example is the determination of the average price from a product search query.

Returns:

aggregations

setAggregations

public void setAggregations(List<Object> aggregations)

page

public ProductListingResult page(Integer page)

getPage

@Nullable
public Integer getPage()

The actual page. This can be used for pagination.

Returns:

page

setPage

public void setPage(Integer page)

limit

public ProductListingResult limit(Integer limit)

getLimit

@Nullable
public Integer getLimit()

The actual limit. This is used for pagination and goes together with the page.

Returns:

limit

setLimit

public void setLimit(Integer limit)

currentFilters

public ProductListingResult currentFilters(ProductListingResultAllOfCurrentFilters currentFilters)

getCurrentFilters

@Nullable
public ProductListingResultAllOfCurrentFilters getCurrentFilters()

Get currentFilters

Returns:

currentFilters

setCurrentFilters

public void setCurrentFilters(ProductListingResultAllOfCurrentFilters currentFilters)

availableSortings

public ProductListingResult availableSortings(List<Object> availableSortings)

addAvailableSortingsItem

public ProductListingResult addAvailableSortingsItem(Object availableSortingsItem)

getAvailableSortings

@Nullable
public List<Object> getAvailableSortings()

Contains the available sorting. These can be used to show a sorting select-box in the product listing.

Returns:

availableSortings

setAvailableSortings

public void setAvailableSortings(List<Object> availableSortings)

sorting

public ProductListingResult sorting(String sorting)

getSorting

@Nullable
public String getSorting()

Get sorting

Returns:

sorting

setSorting

public void setSorting(String sorting)

elements

public ProductListingResult elements(List<Product> elements)

addElementsItem

public ProductListingResult addElementsItem(Product elementsItem)

getElements

@Nullable
public List<Product> getElements()

Get elements

Returns:

elements

setElements

public void setElements(List<Product> elements)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object