Class SearchObject

  • All Implemented Interfaces:
    Resource, Adaptable

    public class SearchObject
    extends QueryExecutor
    Since:
    8.3 Search endpoint to perform queries via rest api, with support to save and execute saved search queries.
    • Constructor Detail

      • SearchObject

        public SearchObject()
    • Method Detail

      • doQueryByLang

        public Object doQueryByLang​(@Context
                                    javax.ws.rs.core.UriInfo uriInfo)
        Since:
        10.3
      • doBulkActionByLang

        public Object doBulkActionByLang​(@Context
                                         javax.ws.rs.core.UriInfo uriInfo)
        Since:
        10.3
      • doQueryByPageProvider

        public Object doQueryByPageProvider​(@Context
                                            javax.ws.rs.core.UriInfo uriInfo,
                                            String pageProviderName)
      • doBulkActionByPageProvider

        public Object doBulkActionByPageProvider​(String pageProviderName,
                                                 @Context
                                                 javax.ws.rs.core.UriInfo uriInfo)
      • doGetSavedSearches

        public List<SavedSearch> doGetSavedSearches​(@Context
                                                    javax.ws.rs.core.UriInfo uriInfo)
      • doSaveSearch

        public javax.ws.rs.core.Response doSaveSearch​(SavedSearchRequest request)
      • doGetSavedSearch

        public javax.ws.rs.core.Response doGetSavedSearch​(String id)
      • doBulkActionBySavedSearch

        public Object doBulkActionBySavedSearch​(String id,
                                                @Context
                                                javax.ws.rs.core.UriInfo uriInfo)
      • doUpdateSavedSearch

        public javax.ws.rs.core.Response doUpdateSavedSearch​(SavedSearchRequest request,
                                                             String id)
      • doDeleteSavedSearch

        public javax.ws.rs.core.Response doDeleteSavedSearch​(String id)
      • doExecuteSavedSearch

        public Object doExecuteSavedSearch​(String id,
                                           @Context
                                           javax.ws.rs.core.UriInfo uriInfo)
      • getPageProvider

        protected PageProvider<?> getPageProvider​(String providerName,
                                                  javax.ws.rs.core.MultivaluedMap<String,​String> parameters)
        Retrieves the page provider from the given page provider name and/or parameters.
        Since:
        2021.8
      • getQueryString

        protected String getQueryString​(String providerName,
                                        javax.ws.rs.core.MultivaluedMap<String,​String> parameters)
        Retrieves the query string from the given page provider name and/or parameters.
      • getQueryString

        protected String getQueryString​(PageProvider<?> pageProvider)
        Retrieves the query string from the given page provider.
        Since:
        2021.8