Package org.nuxeo.ecm.platform.query.api

Interface PageProviderService

All Superinterfaces:

Serializable

All Known Implementing Classes:

PageProviderServiceImpl

public interface PageProviderService
extends Serializable

Since:

5.4

Author:

Anahide Tchertchian

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAMED_PARAMETERS	Name of the search document model context map property holding named parameters.

Method Summary

Modifier and Type	Method	Description
default PageProvider<?>	getPageProvider(String name, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, Object... parameters)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.20, use getPageProvider(PageProviderSpec) instead.
default PageProvider<?>	getPageProvider(String name, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, List<String> highlights, List<QuickFilter> quickFilters, Object... parameters)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.20, use getPageProvider(PageProviderSpec) instead.
default PageProvider<?>	getPageProvider(String name, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Long currentOffset, Map<String,Serializable> properties, List<String> highlights, List<QuickFilter> quickFilters, Object... parameters)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.20, use getPageProvider(PageProviderSpec) instead.
default PageProvider<?>	getPageProvider(String name, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, Object... parameters)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.20, use getPageProvider(PageProviderSpec) instead.
default PageProvider<?>	getPageProvider(String name, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, List<String> highlights, List<QuickFilter> quickFilters, Object... parameters)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.20, use getPageProvider(PageProviderSpec) instead.
default PageProvider<?>	getPageProvider(String name, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, List<QuickFilter> quickFilters, Object... parameters)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.20, use getPageProvider(PageProviderSpec) instead.
default PageProvider<?>	getPageProvider(String name, PageProviderDefinition desc, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Long currentOffset, Map<String,Serializable> properties, List<String> highlights, List<QuickFilter> quickFilters, Object... parameters)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.20, use getPageProvider(PageProviderSpec) instead.
default PageProvider<?>	getPageProvider(String name, PageProviderDefinition desc, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, Object... parameters)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.20, use getPageProvider(PageProviderSpec) instead.
default PageProvider<?>	getPageProvider(String name, PageProviderDefinition desc, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, List<String> highlights, List<QuickFilter> quickFilters, Object... parameters)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.20, use getPageProvider(PageProviderSpec) instead.
default PageProvider<?>	getPageProvider(String name, PageProviderDefinition desc, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, List<QuickFilter> quickFilters, Object... parameters)	Deprecated, for removal: This API element is subject to removal in a future version. since 2025.20, use getPageProvider(PageProviderSpec) instead.
PageProvider<?>	getPageProvider(PageProviderSpec spec)	Returns an instance of page provider built from the given spec.
PageProviderDefinition	getPageProviderDefinition(String name)	Returns a named page provider definition.
Set<String>	getPageProviderDefinitionNames()	Returns all the registered page provider names, or an empty set if no page provider is registered.
default PageProviderCheckResult	runPageProviderCheck(PageProviderCheckRequest request)	Runs the given check request and returns its result.

Field Details

NAMED_PARAMETERS

static final String NAMED_PARAMETERS

Name of the search document model context map property holding named parameters.

Since:

7.1

See Also:

• Constant Field Values

Method Details

getPageProviderDefinition

PageProviderDefinition getPageProviderDefinition(String name)

Returns a named page provider definition.

Useful to share the definition between the page provider service, and the content view service (as content views can reference a named page provider that is already registered instead of redefining it).

Parameters:

name - the page provider name

Returns:

the page provider definition or null, if no page provider with this name was found.

Since:

5.4

getPageProvider

PageProvider<?> getPageProvider(@Nonnull
 PageProviderSpec spec)

Returns an instance of page provider built from the given spec.

When the definition is not set on the spec, the definition is resolved from the registered providers using the spec name, throwing a NuxeoException when no provider is registered under that name.

Since:

2025.20

getPageProvider

@Deprecated(since="2025.20",
            forRemoval=true)
default PageProvider<?> getPageProvider(String name,
 PageProviderDefinition desc,
 DocumentModel searchDocument,
 List<SortInfo> sortInfos,
 Long pageSize,
 Long currentPage,
 Map<String,Serializable> properties,
 Object... parameters)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.20, use getPageProvider(PageProviderSpec) instead.

Returns an instance of page provider with given name and definition.

Useful to share the definition between the page provider service, and the content view service (as content views can reference a named page provider that is already registered instead of redefining it).

If not null, parameters sortInfos and pageSize will override information computed in the XML file. If not null, currentPage will override default current page (0).

Parameters:

name - the name that will be set on the provider.

desc - the definition used to build the provider instance.

searchDocument - the search document to be used by the provider.

sortInfos - sort information to set on the provider instance.

pageSize - the provider page size.

currentPage - the provider current page index.

properties - the provider properties

parameters - the provider parameters.

Returns:

the page provider instance.

Since:

5.7

getPageProvider

@Deprecated(since="2025.20",
            forRemoval=true)
default PageProvider<?> getPageProvider(String name,
 List<SortInfo> sortInfos,
 Long pageSize,
 Long currentPage,
 Map<String,Serializable> properties,
 Object... parameters)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.20, use getPageProvider(PageProviderSpec) instead.

Returns an instance of page provider with given name.

Parameters:

name - the page provider name

sortInfos - sort information to set on the provider instance.

pageSize - the provider page size.

currentPage - the provider current page index.

properties - the provider properties

parameters - the provider parameters.

Returns:

the page provider instance.

Since:

5.4

getPageProvider

@Deprecated(since="2025.20",
            forRemoval=true)
default PageProvider<?> getPageProvider(String name,
 DocumentModel searchDocument,
 List<SortInfo> sortInfos,
 Long pageSize,
 Long currentPage,
 Map<String,Serializable> properties,
 Object... parameters)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.20, use getPageProvider(PageProviderSpec) instead.

Returns an instance of page provider with given name.

Since:

5.7

See Also:

• getPageProvider(String, PageProviderDefinition, DocumentModel, List, Long, Long, Map, Object...)

getPageProvider

@Deprecated(since="2025.20",
            forRemoval=true)
default PageProvider<?> getPageProvider(String name,
 DocumentModel searchDocument,
 List<SortInfo> sortInfos,
 Long pageSize,
 Long currentPage,
 Map<String,Serializable> properties,
 List<QuickFilter> quickFilters,
 Object... parameters)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.20, use getPageProvider(PageProviderSpec) instead.

Returns an instance of page provider with given name.

Since:

8.4

See Also:

• getPageProvider(String, DocumentModel, List, Long, Long, Map, Object...)

getPageProvider

@Deprecated(since="2025.20",
            forRemoval=true)
default PageProvider<?> getPageProvider(String name,
 PageProviderDefinition desc,
 DocumentModel searchDocument,
 List<SortInfo> sortInfos,
 Long pageSize,
 Long currentPage,
 Map<String,Serializable> properties,
 List<QuickFilter> quickFilters,
 Object... parameters)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.20, use getPageProvider(PageProviderSpec) instead.

Returns an instance of page provider with given name.

Since:

8.4

See Also:

• getPageProvider(String, PageProviderDefinition, DocumentModel, List, Long, Long, Map, Object...)

getPageProvider

@Deprecated(since="2025.20",
            forRemoval=true)
default PageProvider<?> getPageProvider(String name,
 List<SortInfo> sortInfos,
 Long pageSize,
 Long currentPage,
 Map<String,Serializable> properties,
 List<String> highlights,
 List<QuickFilter> quickFilters,
 Object... parameters)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.20, use getPageProvider(PageProviderSpec) instead.

Returns an instance of page provider with given name.

Since:

9.1

See Also:

• getPageProvider(String, List, Long, Long, Map, Object...)

getPageProvider

@Deprecated(since="2025.20",
            forRemoval=true)
default PageProvider<?> getPageProvider(String name,
 DocumentModel searchDocument,
 List<SortInfo> sortInfos,
 Long pageSize,
 Long currentPage,
 Map<String,Serializable> properties,
 List<String> highlights,
 List<QuickFilter> quickFilters,
 Object... parameters)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.20, use getPageProvider(PageProviderSpec) instead.

Returns an instance of page provider with given name.

Since:

9.1

See Also:

• getPageProvider(String, DocumentModel, List, Long, Long, Map, Object...)

getPageProvider

@Deprecated(since="2025.20",
            forRemoval=true)
default PageProvider<?> getPageProvider(String name,
 DocumentModel searchDocument,
 List<SortInfo> sortInfos,
 Long pageSize,
 Long currentPage,
 Long currentOffset,
 Map<String,Serializable> properties,
 List<String> highlights,
 List<QuickFilter> quickFilters,
 Object... parameters)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.20, use getPageProvider(PageProviderSpec) instead.

Returns an instance of page provider with given name.

Parameters:

name - the name that will be set on the provider.

searchDocument - the search document to be used by the provider.

sortInfos - sort information to set on the provider instance.

pageSize - the provider page size.

currentPage - the provider current page index. Ignored if currentOffset set.

currentOffset - the provider current offset.

properties - the provider properties.

highlights - list of the fields to be highlighted.

quickFilters - list of the quickFilters to be applied.

parameters - the provider parameters.

Returns:

the page provider instance.

Since:

9.3

getPageProvider

@Deprecated(since="2025.20",
            forRemoval=true)
default PageProvider<?> getPageProvider(String name,
 PageProviderDefinition desc,
 DocumentModel searchDocument,
 List<SortInfo> sortInfos,
 Long pageSize,
 Long currentPage,
 Map<String,Serializable> properties,
 List<String> highlights,
 List<QuickFilter> quickFilters,
 Object... parameters)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.20, use getPageProvider(PageProviderSpec) instead.

Returns an instance of page provider with given name.

Since:

9.1

See Also:

• getPageProvider(String, PageProviderDefinition, DocumentModel, List, Long, Long, Map, Object...)

getPageProvider

@Deprecated(since="2025.20",
            forRemoval=true)
default PageProvider<?> getPageProvider(String name,
 PageProviderDefinition desc,
 DocumentModel searchDocument,
 List<SortInfo> sortInfos,
 Long pageSize,
 Long currentPage,
 Long currentOffset,
 Map<String,Serializable> properties,
 List<String> highlights,
 List<QuickFilter> quickFilters,
 Object... parameters)

Deprecated, for removal: This API element is subject to removal in a future version.

since 2025.20, use getPageProvider(PageProviderSpec) instead.

Returns an instance of page provider with given name and definition.

If not null, parameters sortInfos and pageSize will override information computed in the XML file. If not null, currentPage will override default current page (0).

Parameters:

name - the name that will be set on the provider.

desc - the definition used to build the provider instance.

searchDocument - the search document to be used by the provider.

sortInfos - sort information to set on the provider instance.

pageSize - the provider page size.

currentPage - the provider current page index. Ignored if currentOffset set.

currentOffset - the provider current page offset.

properties - the provider properties.

highlights - list of the fields to be highlighted.

quickFilters - list of the quickFilters to be applied.

parameters - the provider parameters.

Returns:

the page provider instance.

Since:

9.3

getPageProviderDefinitionNames

Set<String> getPageProviderDefinitionNames()

Returns all the registered page provider names, or an empty set if no page provider is registered.

Since:

6.0

runPageProviderCheck

default PageProviderCheckResult runPageProviderCheck(PageProviderCheckRequest request)

Runs the given check request and returns its result.

The page provider will be run with the different given executions.

Since:

2025.19