Package org.nuxeo.ecm.platform.query.api
Class PageProviderSpec
java.lang.Object
org.nuxeo.ecm.platform.query.api.PageProviderSpec
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 -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final StringProperty name used to pass aCoreSessionto the page provider throughproperties.static final StringParameter placeholder substituted with the current repository name when aCoreSessionproperty is provided.static final StringParameter placeholder substituted with the current user name when aCoreSessionproperty is provided.protected final Longprotected final Longprotected final PageProviderDefinitionstatic final Stringprotected final Stringprotected final Longprotected final Object[]protected final Map<String,Serializable> protected final List<QuickFilter>protected final DocumentModel -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic PageProviderSpec.BuilderReturns a new builder for the given page providername, eagerly resolving itsPageProviderDefinitionfrom the registered providers.static PageProviderSpec.Builderbuilder(String name, PageProviderDefinition definition) Returns a new builder for the given page providernameanddefinition.static PageProviderSpec.Builderbuilder(PageProviderDefinition definition) Returns a new builder for the given page providerdefinition.name()pageSize()Object[]toSortInfos(List<String> sortBys, List<String> sortOrders) Builds a list ofSortInfofrom the given parallelsortBysandsortOrderslists, where each order entry is either"asc"or"desc"(case-insensitive).
-
Field Details
-
ASC
- See Also:
-
DESC
- See Also:
-
CORE_SESSION_PROPERTY
Property name used to pass aCoreSessionto the page provider throughproperties.When this property is set,
PageProviderService.getPageProvider(PageProviderSpec)also substitutes any occurrence ofCURRENT_USER_PARAMETER_VALUEorCURRENT_REPOSITORY_PARAMETER_VALUEinparameters()with the session's principal name and repository name respectively.- See Also:
-
CURRENT_USER_PARAMETER_VALUE
Parameter placeholder substituted with the current user name when aCoreSessionproperty is provided.- See Also:
-
CURRENT_REPOSITORY_PARAMETER_VALUE
Parameter placeholder substituted with the current repository name when aCoreSessionproperty is provided.- See Also:
-
name
-
definition
-
searchDocument
-
sortInfos
-
pageSize
-
currentPage
-
currentPageOffset
-
properties
-
highlights
-
quickFilters
-
parameters
-
-
Constructor Details
-
PageProviderSpec
-
-
Method Details
-
builder
Returns a new builder for the given page providername, eagerly resolving itsPageProviderDefinitionfrom the registered providers.- Throws:
NuxeoException- if no page provider definition is registered forname
-
builder
Returns a new builder for the given page providerdefinition. -
builder
Returns a new builder for the given page providernameanddefinition. -
name
-
definition
-
searchDocument
-
sortInfos
-
pageSize
-
currentPage
-
currentPageOffset
-
properties
-
highlights
-
quickFilters
-
parameters
-
toSortInfos
Builds a list ofSortInfofrom the given parallelsortBysandsortOrderslists, where each order entry is either"asc"or"desc"(case-insensitive).- Since:
- 2025.20
-