Class SearchObject
java.lang.Object
org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>
org.nuxeo.ecm.restapi.server.jaxrs.search.QueryExecutor
org.nuxeo.ecm.restapi.server.jaxrs.search.SearchObject
- Since:
- 8.3 Search endpoint to perform queries via rest api, with support to save and execute saved search queries.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.nuxeo.ecm.restapi.server.jaxrs.search.QueryExecutor
QueryExecutor.LangParams, QueryExecutor.QueryParams
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
static final String
static final String
protected SavedSearchService
Fields inherited from class org.nuxeo.ecm.restapi.server.jaxrs.search.QueryExecutor
CURRENT_PAGE_INDEX, CURRENT_PAGE_OFFSET, CURRENT_REPO_PATTERN, CURRENT_USERID_PATTERN, HIGHLIGHT, MAX_RESULTS, NXQL, ORDERED_PARAMS, PAGE_SIZE, pageProviderService, QUERY, QUERY_LIMIT_PARAM, QUICK_FILTERS, SCROLL_PARAM, skipAggregates, SORT_BY, SORT_ORDER
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiondoBulkActionByLang
(javax.ws.rs.core.UriInfo uriInfo) doBulkActionByLang
(javax.ws.rs.core.UriInfo uriInfo, String queryLanguage) Deprecated.doBulkActionByPageProvider
(String pageProviderName, javax.ws.rs.core.UriInfo uriInfo) doBulkActionBySavedSearch
(String id, javax.ws.rs.core.UriInfo uriInfo) javax.ws.rs.core.Response
doExecuteSavedSearch
(String id, javax.ws.rs.core.UriInfo uriInfo) doGetPageProviderDefinition
(String pageProviderName) javax.ws.rs.core.Response
doGetSavedSearches
(javax.ws.rs.core.UriInfo uriInfo) doQueryByLang
(javax.ws.rs.core.UriInfo uriInfo) doQueryByLang
(javax.ws.rs.core.UriInfo uriInfo, String queryLanguage) Deprecated.since 10.3, usedoQueryByLang(UriInfo)
instead.doQueryByPageProvider
(javax.ws.rs.core.UriInfo uriInfo, String pageProviderName) javax.ws.rs.core.Response
doSaveSearch
(SavedSearchRequest request) javax.ws.rs.core.Response
doUpdateSavedSearch
(SavedSearchRequest request, String id) protected DocumentModelList
executeSavedSearch
(SavedSearch search, javax.ws.rs.core.MultivaluedMap<String, String> params) 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.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.protected String
getQueryString
(PageProvider<?> pageProvider) Retrieves the query string from the given page provider.void
initialize
(Object... args) protected DocumentModelList
querySavedSearchByLang
(String queryLanguage, String query, Long pageSize, Long currentPageIndex, Long currentPageOffset, Long maxResults, String orderedParams, Map<String, String> namedParameters, List<SortInfo> sortInfo) protected DocumentModelList
querySavedSearchByPageProvider
(String pageProviderName, Long pageSize, Long currentPageIndex, Long currentPageOffset, String orderedParams, Map<String, String> namedParameters, List<SortInfo> sortInfo, List<QuickFilter> quickFilters, DocumentModel searchDocumentModel) protected void
setSaveSearchParams
(Map<String, String> params, SavedSearch search) Methods inherited from class org.nuxeo.ecm.restapi.server.jaxrs.search.QueryExecutor
asStringList, buildResponse, getCurrentPageIndex, getCurrentPageOffset, getHighlights, getMaxResults, getNamedParameters, getNamedParameters, getPageProviderDefinition, getPageSize, getParameters, getProperties, getQuery, getQuickFilters, getSortInfo, getSortInfo, handleNamedParamVars, initExecutor, queryByLang, queryByLang, queryByLang, queryByPageProvider, queryByPageProvider, queryByPageProvider, replaceParameterPattern
Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource
checkGuard, dispose, getActiveAdapter, getAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, isAdapter, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot, toString
-
Field Details
-
SAVED_SEARCHES_PAGE_PROVIDER
- See Also:
-
SAVED_SEARCHES_PAGE_PROVIDER_PARAMS
- See Also:
-
PAGE_PROVIDER_NAME_PARAM
- See Also:
-
savedSearchService
-
-
Constructor Details
-
SearchObject
public SearchObject()
-
-
Method Details
-
initialize
- Overrides:
initialize
in classAbstractResource<ResourceTypeImpl>
-
doQueryByLang
@Deprecated public Object doQueryByLang(@Context javax.ws.rs.core.UriInfo uriInfo, String queryLanguage) Deprecated.since 10.3, usedoQueryByLang(UriInfo)
instead. -
doQueryByLang
- Since:
- 10.3
-
doBulkActionByLang
@Deprecated public Object doBulkActionByLang(@Context javax.ws.rs.core.UriInfo uriInfo, String queryLanguage) Deprecated.since 10.3, usedoBulkActionByLang(UriInfo)
instead. -
doBulkActionByLang
- Since:
- 10.3
-
doQueryByPageProvider
-
doGetPageProviderDefinition
- Throws:
IOException
-
doBulkActionByPageProvider
-
doGetSavedSearches
-
doSaveSearch
-
doGetSavedSearch
-
doBulkActionBySavedSearch
-
doUpdateSavedSearch
-
doDeleteSavedSearch
-
doExecuteSavedSearch
-
setSaveSearchParams
protected void setSaveSearchParams(Map<String, String> params, SavedSearch search) throws IOException- Throws:
IOException
-
executeSavedSearch
protected DocumentModelList executeSavedSearch(SavedSearch search, javax.ws.rs.core.MultivaluedMap<String, String> params) -
querySavedSearchByLang
-
querySavedSearchByPageProvider
protected DocumentModelList querySavedSearchByPageProvider(String pageProviderName, Long pageSize, Long currentPageIndex, Long currentPageOffset, String orderedParams, Map<String, String> namedParameters, List<SortInfo> sortInfo, List<QuickFilter> quickFilters, DocumentModel searchDocumentModel) -
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
Retrieves the query string from the given page provider.- Since:
- 2021.8
-
doBulkActionByLang(UriInfo)
instead.