Package de.codebarista.shopware.model.core

Class SearchPageRequest

java.lang.Object
de.codebarista.shopware.model.core.SearchPageRequest
@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 SearchPageRequest extends Object
SearchPageRequest

  • Field Details

  • Constructor Details

    • SearchPageRequest

      public SearchPageRequest()

  • Method Details

    • page

      public SearchPageRequest page(Integer page)

    • getPage

      @Nullable public Integer getPage()
      Search result page
      Returns:
      page

    • setPage

      public void setPage(Integer page)

    • limit

      public SearchPageRequest limit(Integer limit)

    • getLimit

      @Nullable public Integer getLimit()
      Number of items per result page. If not set, the limit will be set according to the default products per page, defined in the system settings. minimum: 0
      Returns:
      limit

    • setLimit

      public void setLimit(Integer limit)

    • filter

      public SearchPageRequest filter(List<CriteriaFilterInner> filter)

    • addFilterItem

      public SearchPageRequest 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 SearchPageRequest sort(List<CriteriaSortInner> sort)

    • addSortItem

      public SearchPageRequest 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 SearchPageRequest postFilter(List<CriteriaFilterInner> postFilter)

    • addPostFilterItem

      public SearchPageRequest 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 SearchPageRequest 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 SearchPageRequest aggregations(List<CriteriaAggregationsInner> aggregations)

    • addAggregationsItem

      public SearchPageRequest 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 SearchPageRequest grouping(List<String> grouping)

    • addGroupingItem

      public SearchPageRequest 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 SearchPageRequest fields(List<String> fields)

    • addFieldsItem

      public SearchPageRequest 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 SearchPageRequest totalCountMode(SearchPageRequest.TotalCountModeEnum totalCountMode)

    • getTotalCountMode

      @Nullable public SearchPageRequest.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(SearchPageRequest.TotalCountModeEnum totalCountMode)

    • order

      public SearchPageRequest order(String order)

    • getOrder

      @Nullable public String getOrder()
      Specifies the sorting of the products by `availableSortings`. If not set, the default sorting will be set according to the shop settings. The available sorting options are sent within the response under the `availableSortings` key. In order to sort by a field, consider using the `sort` parameter from the listing criteria. Do not use both parameters together, as it might lead to unexpected results.
      Returns:
      order

    • setOrder

      public void setOrder(String order)

    • p

      public SearchPageRequest p(Integer p)

    • getP

      @Nullable public Integer getP()
      Search result page
      Returns:
      p

    • setP

      public void setP(Integer p)

    • manufacturer

      public SearchPageRequest manufacturer(String manufacturer)

    • getManufacturer

      @Nullable public String getManufacturer()
      Filter by manufacturers. List of manufacturer identifiers separated by a `|`.
      Returns:
      manufacturer

    • setManufacturer

      public void setManufacturer(String manufacturer)

    • minPrice

      public SearchPageRequest minPrice(Integer minPrice)

    • getMinPrice

      @Nullable public Integer getMinPrice()
      Filters by a minimum product price. Has to be lower than the `max-price` filter. minimum: 0
      Returns:
      minPrice

    • setMinPrice

      public void setMinPrice(Integer minPrice)

    • maxPrice

      public SearchPageRequest maxPrice(Integer maxPrice)

    • getMaxPrice

      @Nullable public Integer getMaxPrice()
      Filters by a maximum product price. Has to be higher than the `min-price` filter. minimum: 0
      Returns:
      maxPrice

    • setMaxPrice

      public void setMaxPrice(Integer maxPrice)

    • rating

      public SearchPageRequest rating(Integer rating)

    • getRating

      @Nullable public Integer getRating()
      Filter products with a minimum average rating.
      Returns:
      rating

    • setRating

      public void setRating(Integer rating)

    • shippingFree

      public SearchPageRequest shippingFree(Boolean shippingFree)

    • getShippingFree

      @Nullable public Boolean getShippingFree()
      Filters products that are marked as shipping-free.
      Returns:
      shippingFree

    • setShippingFree

      public void setShippingFree(Boolean shippingFree)

    • properties

      public SearchPageRequest properties(String properties)

    • getProperties

      @Nullable public String getProperties()
      Filters products by their properties. List of property identifiers separated by a `|`.
      Returns:
      properties

    • setProperties

      public void setProperties(String properties)

    • manufacturerFilter

      public SearchPageRequest manufacturerFilter(Boolean manufacturerFilter)

    • getManufacturerFilter

      @Nullable public Boolean getManufacturerFilter()
      Enables/disabled filtering by manufacturer. If set to false, the `manufacturer` filter will be ignored. Also the `aggregations[manufacturer]` key will be removed from the response.
      Returns:
      manufacturerFilter

    • setManufacturerFilter

      public void setManufacturerFilter(Boolean manufacturerFilter)

    • priceFilter

      public SearchPageRequest priceFilter(Boolean priceFilter)

    • getPriceFilter

      @Nullable public Boolean getPriceFilter()
      Enables/disabled filtering by price. If set to false, the `min-price` and `max-price` filter will be ignored. Also the `aggregations[price]` key will be removed from the response.
      Returns:
      priceFilter

    • setPriceFilter

      public void setPriceFilter(Boolean priceFilter)

    • ratingFilter

      public SearchPageRequest ratingFilter(Boolean ratingFilter)

    • getRatingFilter

      @Nullable public Boolean getRatingFilter()
      Enables/disabled filtering by rating. If set to false, the `rating` filter will be ignored. Also the `aggregations[rating]` key will be removed from the response.
      Returns:
      ratingFilter

    • setRatingFilter

      public void setRatingFilter(Boolean ratingFilter)

    • shippingFreeFilter

      public SearchPageRequest shippingFreeFilter(Boolean shippingFreeFilter)

    • getShippingFreeFilter

      @Nullable public Boolean getShippingFreeFilter()
      Enables/disabled filtering by shipping-free products. If set to false, the `shipping-free` filter will be ignored. Also the `aggregations[shipping-free]` key will be removed from the response.
      Returns:
      shippingFreeFilter

    • setShippingFreeFilter

      public void setShippingFreeFilter(Boolean shippingFreeFilter)

    • propertyFilter

      public SearchPageRequest propertyFilter(Boolean propertyFilter)

    • getPropertyFilter

      @Nullable public Boolean getPropertyFilter()
      Enables/disabled filtering by properties products. If set to false, the `properties` filter will be ignored. Also the `aggregations[properties]` key will be removed from the response.
      Returns:
      propertyFilter

    • setPropertyFilter

      public void setPropertyFilter(Boolean propertyFilter)

    • propertyWhitelist

      public SearchPageRequest propertyWhitelist(String propertyWhitelist)

    • getPropertyWhitelist

      @Nullable public String getPropertyWhitelist()
      A whitelist of property identifiers which can be used for filtering. List of property identifiers separated by a `|`. The `property-filter` must be `true`, otherwise the whitelist has no effect.
      Returns:
      propertyWhitelist

    • setPropertyWhitelist

      public void setPropertyWhitelist(String propertyWhitelist)

    • reduceAggregations

      public SearchPageRequest reduceAggregations(String reduceAggregations)

    • getReduceAggregations

      @Nullable public String getReduceAggregations()
      By sending the parameter `reduce-aggregations` , the post-filters that were applied by the customer, are also applied to the aggregations. This has the consequence that only values are returned in the aggregations that would lead to further filter results. This parameter is a flag, the value has no effect.
      Returns:
      reduceAggregations

    • getReduceAggregations_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getReduceAggregations_JsonNullable()

    • setReduceAggregations_JsonNullable

      public void setReduceAggregations_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> reduceAggregations)

    • setReduceAggregations

      public void setReduceAggregations(String reduceAggregations)

    • noAggregations

      public SearchPageRequest noAggregations(String noAggregations)

    • getNoAggregations

      @Nullable public String getNoAggregations()
      Resets all aggregations in the criteria. This parameter is a flag, the value has no effect.
      Returns:
      noAggregations

    • getNoAggregations_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getNoAggregations_JsonNullable()

    • setNoAggregations_JsonNullable

      public void setNoAggregations_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> noAggregations)

    • setNoAggregations

      public void setNoAggregations(String noAggregations)

    • onlyAggregations

      public SearchPageRequest onlyAggregations(String onlyAggregations)

    • getOnlyAggregations

      @Nullable public String getOnlyAggregations()
      If this flag is set, no products are fetched. Sorting and associations are also ignored. This parameter is a flag, the value has no effect.
      Returns:
      onlyAggregations

    • getOnlyAggregations_JsonNullable

      public org.openapitools.jackson.nullable.JsonNullable<String> getOnlyAggregations_JsonNullable()

    • setOnlyAggregations_JsonNullable

      public void setOnlyAggregations_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> onlyAggregations)

    • setOnlyAggregations

      public void setOnlyAggregations(String onlyAggregations)

    • search

      public SearchPageRequest search(String search)

    • getSearch

      @Nonnull public String getSearch()
      Using the search parameter, the server performs a text search on all records based on their data model and weighting as defined in the entity definition using the SearchRanking flag.
      Returns:
      search

    • setSearch

      public void setSearch(String search)

    • 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