Package ch.tocco.nice2.rest.entity.spi.search

Interface SearchRequest

All Known Implementing Classes:
AbstractSearchRequest, PathSearchRequest
public interface SearchRequest
can be used to build queries from REST requests, use a SearchRequest.Builder to create the request and RestSearchService to execute it

  • Method Details

    • getBase

      SearchRequest.Base getBase()

    • setBase

      void setBase(SearchRequest.Base base)

    • getOffset

      Optional<Integer> getOffset()

    • setOffset

      void setOffset(@Nullable @Nullable Integer offset)

    • getLimit

      Optional<Integer> getLimit()

    • setLimit

      void setLimit(@Nullable @Nullable Integer limit)

    • getSort

      Optional<String> getSort()

    • setPaths

      void setPaths(@Nullable @Nullable RequestedPaths paths)

    • getPaths

      Optional<RequestedPaths> getPaths()

    • setSort

      void setSort(@Nullable @Nullable String sort)

    • getQueryParameters

      jakarta.ws.rs.core.MultivaluedMap<String,String> getQueryParameters()

    • getAdditionalConditions

      List<Condition> getAdditionalConditions()

    • addAdditionalCondition

      void addAdditionalCondition(Condition condition)

    • createEntityBeanListFactory

      EntityBeanListFactory createEntityBeanListFactory()

    • setAllKeys

      void setAllKeys(boolean allKeys)

    • isAllKeys

      boolean isAllKeys()
      If set to true, the request returns the key path only and the whole result set without paging