Package de.codebarista.shopware.model.core

Class ReadOrderRequest

java.lang.Object

de.codebarista.shopware.model.core.ReadOrderRequest

@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 ReadOrderRequest
extends Object

ReadOrderRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ReadOrderRequest.TotalCountModeEnum	Whether the total for the total number of hits should be determined for the search query.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_AGGREGATIONS
static final String	JSON_PROPERTY_ASSOCIATIONS
static final String	JSON_PROPERTY_CHECK_PROMOTION
static final String	JSON_PROPERTY_FIELDS
static final String	JSON_PROPERTY_FILTER
static final String	JSON_PROPERTY_GROUPING
static final String	JSON_PROPERTY_LIMIT
static final String	JSON_PROPERTY_PAGE
static final String	JSON_PROPERTY_POST_FILTER
static final String	JSON_PROPERTY_SORT
static final String	JSON_PROPERTY_TOTAL_COUNT_MODE

Constructor Summary

Constructors

Constructor	Description
ReadOrderRequest()

Method Summary

Modifier and Type	Method	Description
ReadOrderRequest	addAggregationsItem(CriteriaAggregationsInner aggregationsItem)
ReadOrderRequest	addFieldsItem(String fieldsItem)
ReadOrderRequest	addFilterItem(CriteriaFilterInner filterItem)
ReadOrderRequest	addGroupingItem(String groupingItem)
ReadOrderRequest	addPostFilterItem(CriteriaFilterInner postFilterItem)
ReadOrderRequest	addSortItem(CriteriaSortInner sortItem)
ReadOrderRequest	aggregations(List<CriteriaAggregationsInner> aggregations)
ReadOrderRequest	associations(Object associations)
ReadOrderRequest	checkPromotion(Boolean checkPromotion)
boolean	equals(Object o)
ReadOrderRequest	fields(List<String> fields)
ReadOrderRequest	filter(List<CriteriaFilterInner> filter)
List<CriteriaAggregationsInner>	getAggregations()	Used to perform aggregations on the search result.
Object	getAssociations()	Used to fetch associations which are not fetched by default.
Boolean	getCheckPromotion()	Check if the payment method of the order is still changeable.
List<String>	getFields()	Fields which should be returned in the search result.
List<CriteriaFilterInner>	getFilter()	List of filters to restrict the search result.
List<String>	getGrouping()	Perform groupings over certain fields
Integer	getLimit()	Number of items per result page
Integer	getPage()	Search result page
List<CriteriaFilterInner>	getPostFilter()	Filters that applied without affecting aggregations.
List<CriteriaSortInner>	getSort()	Sorting in the search result.
ReadOrderRequest.TotalCountModeEnum	getTotalCountMode()	Whether the total for the total number of hits should be determined for the search query.
ReadOrderRequest	grouping(List<String> grouping)
int	hashCode()
ReadOrderRequest	limit(Integer limit)
ReadOrderRequest	page(Integer page)
ReadOrderRequest	postFilter(List<CriteriaFilterInner> postFilter)
void	setAggregations(List<CriteriaAggregationsInner> aggregations)
void	setAssociations(Object associations)
void	setCheckPromotion(Boolean checkPromotion)
void	setFields(List<String> fields)
void	setFilter(List<CriteriaFilterInner> filter)
void	setGrouping(List<String> grouping)
void	setLimit(Integer limit)
void	setPage(Integer page)
void	setPostFilter(List<CriteriaFilterInner> postFilter)
void	setSort(List<CriteriaSortInner> sort)
void	setTotalCountMode(ReadOrderRequest.TotalCountModeEnum totalCountMode)
ReadOrderRequest	sort(List<CriteriaSortInner> sort)
String	toString()
ReadOrderRequest	totalCountMode(ReadOrderRequest.TotalCountModeEnum totalCountMode)

Methods inherited from class java.lang.Object

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

Field Details

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_FILTER

public static final String JSON_PROPERTY_FILTER

See Also:

• Constant Field Values

JSON_PROPERTY_SORT

public static final String JSON_PROPERTY_SORT

See Also:

• Constant Field Values

JSON_PROPERTY_POST_FILTER

public static final String JSON_PROPERTY_POST_FILTER

See Also:

• Constant Field Values

JSON_PROPERTY_ASSOCIATIONS

public static final String JSON_PROPERTY_ASSOCIATIONS

See Also:

• Constant Field Values

JSON_PROPERTY_AGGREGATIONS

public static final String JSON_PROPERTY_AGGREGATIONS

See Also:

• Constant Field Values

JSON_PROPERTY_GROUPING

public static final String JSON_PROPERTY_GROUPING

See Also:

• Constant Field Values

JSON_PROPERTY_FIELDS

public static final String JSON_PROPERTY_FIELDS

See Also:

• Constant Field Values

JSON_PROPERTY_TOTAL_COUNT_MODE

public static final String JSON_PROPERTY_TOTAL_COUNT_MODE

See Also:

• Constant Field Values

JSON_PROPERTY_CHECK_PROMOTION

public static final String JSON_PROPERTY_CHECK_PROMOTION

See Also:

• Constant Field Values

Constructor Details

ReadOrderRequest

public ReadOrderRequest()

Method Details

page

public ReadOrderRequest page(Integer page)

getPage

@Nullable
public Integer getPage()

Search result page

Returns:

page

setPage

public void setPage(Integer page)

limit

public ReadOrderRequest limit(Integer limit)

getLimit

@Nullable
public Integer getLimit()

Number of items per result page

Returns:

limit

setLimit

public void setLimit(Integer limit)

filter

public ReadOrderRequest filter(List<CriteriaFilterInner> filter)

addFilterItem

public ReadOrderRequest addFilterItem(CriteriaFilterInner filterItem)

getFilter

@Nullable
public List<CriteriaFilterInner> getFilter()

List of filters to restrict the search result. For more information, see [Search Queries > Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#filter)

Returns:

filter

setFilter

public void setFilter(List<CriteriaFilterInner> filter)

sort

public ReadOrderRequest sort(List<CriteriaSortInner> sort)

addSortItem

public ReadOrderRequest addSortItem(CriteriaSortInner sortItem)

getSort

@Nullable
public List<CriteriaSortInner> getSort()

Sorting in the search result.

Returns:

sort

setSort

public void setSort(List<CriteriaSortInner> sort)

postFilter

public ReadOrderRequest postFilter(List<CriteriaFilterInner> postFilter)

addPostFilterItem

public ReadOrderRequest addPostFilterItem(CriteriaFilterInner postFilterItem)

getPostFilter

@Nullable
public List<CriteriaFilterInner> getPostFilter()

Filters that applied without affecting aggregations. For more information, see [Search Queries > Post Filter](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#post-filter)

Returns:

postFilter

setPostFilter

public void setPostFilter(List<CriteriaFilterInner> postFilter)

associations

public ReadOrderRequest associations(Object associations)

getAssociations

@Nullable
public Object getAssociations()

Used to fetch associations which are not fetched by default.

Returns:

associations

setAssociations

public void setAssociations(Object associations)

aggregations

public ReadOrderRequest aggregations(List<CriteriaAggregationsInner> aggregations)

addAggregationsItem

public ReadOrderRequest addAggregationsItem(CriteriaAggregationsInner aggregationsItem)

getAggregations

@Nullable
public List<CriteriaAggregationsInner> getAggregations()

Used to perform aggregations on the search result. For more information, see [Search Queries > Aggregations](https://shopware.stoplight.io/docs/store-api/docs/concepts/search-queries.md#aggregations)

Returns:

aggregations

setAggregations

public void setAggregations(List<CriteriaAggregationsInner> aggregations)

grouping

public ReadOrderRequest grouping(List<String> grouping)

addGroupingItem

public ReadOrderRequest addGroupingItem(String groupingItem)

getGrouping

@Nullable
public List<String> getGrouping()

Perform groupings over certain fields

Returns:

grouping

setGrouping

public void setGrouping(List<String> grouping)

fields

public ReadOrderRequest fields(List<String> fields)

addFieldsItem

public ReadOrderRequest addFieldsItem(String fieldsItem)

getFields

@Nullable
public List<String> getFields()

Fields which should be returned in the search result.

Returns:

fields

setFields

public void setFields(List<String> fields)

totalCountMode

public ReadOrderRequest totalCountMode(ReadOrderRequest.TotalCountModeEnum totalCountMode)

getTotalCountMode

@Nullable
public ReadOrderRequest.TotalCountModeEnum getTotalCountMode()

Whether the total for the total number of hits should be determined for the search query. none = disabled total count, exact = calculate exact total amount (slow), next-pages = calculate only for next page (fast)

Returns:

totalCountMode

setTotalCountMode

public void setTotalCountMode(ReadOrderRequest.TotalCountModeEnum totalCountMode)

checkPromotion

public ReadOrderRequest checkPromotion(Boolean checkPromotion)

getCheckPromotion

@Nullable
public Boolean getCheckPromotion()

Check if the payment method of the order is still changeable.

Returns:

checkPromotion

setCheckPromotion

public void setCheckPromotion(Boolean checkPromotion)

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