PageProviderAdapter (Nuxeo 2021.70.4 API Documentation)

java.lang.Object
- org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>
- - org.nuxeo.ecm.webengine.model.impl.DefaultAdapter
  - - org.nuxeo.ecm.restapi.server.jaxrs.adapters.PaginableAdapter<DocumentModel>
    - - org.nuxeo.ecm.restapi.server.jaxrs.adapters.DocumentModelListPaginableAdapter
      - org.nuxeo.ecm.restapi.server.jaxrs.adapters.PageProviderAdapter

All Implemented Interfaces:

AdapterResource, Resource, Adaptable
```
public class PageProviderAdapter
extends DocumentModelListPaginableAdapter
```
Adapter that expose a page provider that needs only one parameter that is the document Id

Since:

5.7.2

Field Summary

Fields
Modifier and Type Field Description

static String NAME
- Fields inherited from class org.nuxeo.ecm.restapi.server.jaxrs.adapters.PaginableAdapter
  currentPageIndex, maxResults, pageSize, sortBy, sortOrder
- Fields inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource
  ctx, next, path, prev, type

Constructor Summary

Constructors
Constructor Description

PageProviderAdapter()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected PageProviderDefinition`	`getPageProviderDefinition()`
`protected Object[]`	`getParams()`
`Paginable<DocumentModel>`	`getProviderDocs(String providerName)`

Methods inherited from class org.nuxeo.ecm.restapi.server.jaxrs.adapters.DocumentModelListPaginableAdapter
getPaginableEntries

Methods inherited from class org.nuxeo.ecm.restapi.server.jaxrs.adapters.PaginableAdapter
extractLongParam, getAdapter, getPaginableEntries, getSearchDocument, initialize

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.DefaultAdapter
disptachAdapter, getTarget, isAdapter

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource
checkGuard, dispose, getActiveAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nuxeo.ecm.webengine.model.Resource
checkGuard, dispose, getActiveAdapter, getContext, getFacets, getLinks, getModule, getName, getNext, getNextSegment, getPath, getPrevious, getTemplate, getTrailingPath, getType, getURL, getView, hasFacet, initialize, isInstanceOf, isRoot, newAdapter, newObject, redirect, setNext, setPrevious, setRoot

- Field Detail
  - NAME
```
public static final String NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PageProviderAdapter
```
public PageProviderAdapter()
```
- Method Detail
  - getPageProviderDefinition
```
protected PageProviderDefinition getPageProviderDefinition()
```
    Specified by:
    
    getPageProviderDefinition in class PaginableAdapter<DocumentModel>
  - getParams
```
protected Object[] getParams()
```
    Overrides:
    
    getParams in class PaginableAdapter<DocumentModel>
  - getProviderDocs
```
public Paginable<DocumentModel> getProviderDocs(String providerName)
```