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

Class PageProviderSpec

java.lang.Object

org.nuxeo.ecm.platform.query.api.PageProviderSpec

public class PageProviderSpec
extends Object

Specification of a PageProvider instantiation request, used by PageProviderService.getPageProvider(PageProviderSpec).

Instances are immutable and can only be created through the PageProviderSpec.Builder returned by builder(String).

Since:

2025.20

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PageProviderSpec.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ASC
static final String	CORE_SESSION_PROPERTY	Property name used to pass a CoreSession to the page provider through properties.
static final String	CURRENT_REPOSITORY_PARAMETER_VALUE	Parameter placeholder substituted with the current repository name when a CoreSession property is provided.
static final String	CURRENT_USER_PARAMETER_VALUE	Parameter placeholder substituted with the current user name when a CoreSession property is provided.
protected final Long	currentPage
protected final Long	currentPageOffset
protected final PageProviderDefinition	definition
static final String	DESC
protected final List<String>	highlights
protected final String	name
protected final Long	pageSize
protected final Object[]	parameters
protected final Map<String,Serializable>	properties
protected final List<QuickFilter>	quickFilters
protected final DocumentModel	searchDocument
protected final List<SortInfo>	sortInfos

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PageProviderSpec(PageProviderSpec.Builder builder)

Method Summary

Modifier and Type	Method	Description
static PageProviderSpec.Builder	builder(String name)	Returns a new builder for the given page provider name, eagerly resolving its PageProviderDefinition from the registered providers.
static PageProviderSpec.Builder	builder(String name, PageProviderDefinition definition)	Returns a new builder for the given page provider name and definition.
static PageProviderSpec.Builder	builder(PageProviderDefinition definition)	Returns a new builder for the given page provider definition.
Long	currentPage()
Long	currentPageOffset()
PageProviderDefinition	definition()
List<String>	highlights()
String	name()
Long	pageSize()
Object[]	parameters()
Map<String,Serializable>	properties()
List<QuickFilter>	quickFilters()
DocumentModel	searchDocument()
List<SortInfo>	sortInfos()
static List<SortInfo>	toSortInfos(List<String> sortBys, List<String> sortOrders)	Builds a list of SortInfo from the given parallel sortBys and sortOrders lists, where each order entry is either "asc" or "desc" (case-insensitive).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

ASC

public static final String ASC

See Also:

• Constant Field Values

DESC

public static final String DESC

See Also:

• Constant Field Values

CORE_SESSION_PROPERTY

public static final String CORE_SESSION_PROPERTY

Property name used to pass a CoreSession to the page provider through properties.

When this property is set, PageProviderService.getPageProvider(PageProviderSpec) also substitutes any occurrence of CURRENT_USER_PARAMETER_VALUE or CURRENT_REPOSITORY_PARAMETER_VALUE in parameters() with the session's principal name and repository name respectively.

See Also:

• Constant Field Values

CURRENT_USER_PARAMETER_VALUE

public static final String CURRENT_USER_PARAMETER_VALUE

Parameter placeholder substituted with the current user name when a CoreSession property is provided.

See Also:

• Constant Field Values

CURRENT_REPOSITORY_PARAMETER_VALUE

public static final String CURRENT_REPOSITORY_PARAMETER_VALUE

Parameter placeholder substituted with the current repository name when a CoreSession property is provided.

See Also:

• Constant Field Values

name

protected final String name

definition

protected final PageProviderDefinition definition

searchDocument

protected final DocumentModel searchDocument

sortInfos

protected final List<SortInfo> sortInfos

pageSize

protected final Long pageSize

currentPage

protected final Long currentPage

currentPageOffset

protected final Long currentPageOffset

properties

protected final Map<String,Serializable> properties

highlights

protected final List<String> highlights

quickFilters

protected final List<QuickFilter> quickFilters

parameters

protected final Object[] parameters

Constructor Details

PageProviderSpec

protected PageProviderSpec(PageProviderSpec.Builder builder)

Method Details

builder

public static PageProviderSpec.Builder builder(String name)

Returns a new builder for the given page provider name, eagerly resolving its PageProviderDefinition from the registered providers.

Throws:

NuxeoException - if no page provider definition is registered for name

builder

public static PageProviderSpec.Builder builder(PageProviderDefinition definition)

Returns a new builder for the given page provider definition.

builder

public static PageProviderSpec.Builder builder(String name,
 PageProviderDefinition definition)

Returns a new builder for the given page provider name and definition.

name

@Nonnull
public String name()

definition

@Nonnull
public PageProviderDefinition definition()

searchDocument

@Nullable
public DocumentModel searchDocument()

sortInfos

@Nullable
public List<SortInfo> sortInfos()

pageSize

@Nullable
public Long pageSize()

currentPage

@Nullable
public Long currentPage()

currentPageOffset

@Nullable
public Long currentPageOffset()

properties

@Nonnull
public Map<String,Serializable> properties()

highlights

@Nullable
public List<String> highlights()

quickFilters

@Nullable
public List<QuickFilter> quickFilters()

parameters

@Nonnull
public Object[] parameters()

toSortInfos

public static List<SortInfo> toSortInfos(List<String> sortBys,
 List<String> sortOrders)

Builds a list of SortInfo from the given parallel sortBys and sortOrders lists, where each order entry is either "asc" or "desc" (case-insensitive).

Since:

2025.20