Package org.nuxeo.ecm.restapi.server

Class PaginableObject<T>

java.lang.Object

org.nuxeo.ecm.webengine.model.impl.AbstractResource<ResourceTypeImpl>

org.nuxeo.ecm.webengine.model.impl.DefaultObject

org.nuxeo.ecm.restapi.server.PaginableObject<T>

All Implemented Interfaces:

Resource, Adaptable

Direct Known Subclasses:

AbstractUMRootObject, DirectoryObject, TaskObject

public abstract class PaginableObject<T>
extends DefaultObject

Paginable WebObject.

To be extended by WebObject returning paginable entries based on a PageProvider.

Since:

5.8

Field Summary

Fields

Modifier and Type	Field	Description
protected Long	currentPageIndex
protected String	maxResults
protected Long	offset
protected Long	pageSize

Fields inherited from class org.nuxeo.ecm.webengine.model.impl.AbstractResource

ctx, next, path, prev, type

Constructor Summary

Constructors

Constructor	Description
PaginableObject()

Method Summary

Modifier and Type	Method	Description
protected Long	extractLongParam(jakarta.servlet.http.HttpServletRequest request, String paramName, Long defaultValue)
protected abstract PageProviderDefinition	getPageProviderDefinition()
Paginable<T>	getPaginableEntries()
protected Paginable<T>	getPaginableEntries(PageProvider<T> pageProvider)
protected Object[]	getParams()
protected DocumentModel	getSearchDocument()
protected void	initialize(Object... args)

Methods inherited from class org.nuxeo.ecm.webengine.model.impl.DefaultObject

disptachAdapter, isAdapter

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, isInstanceOf, isRoot, newAdapter, newObject, newObject, redirect, retrieveWebObjectType, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

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

Field Details

currentPageIndex

protected Long currentPageIndex

offset

protected Long offset

pageSize

protected Long pageSize

maxResults

protected String maxResults

Constructor Details

PaginableObject

public PaginableObject()

Method Details

initialize

protected void initialize(Object... args)

Overrides:

initialize in class AbstractResource<ResourceTypeImpl>

getPageProviderDefinition

protected abstract PageProviderDefinition getPageProviderDefinition()

getParams

protected Object[] getParams()

getSearchDocument

protected DocumentModel getSearchDocument()

getPaginableEntries

public Paginable<T> getPaginableEntries()

getPaginableEntries

protected Paginable<T> getPaginableEntries(PageProvider<T> pageProvider)

extractLongParam

protected Long extractLongParam(jakarta.servlet.http.HttpServletRequest request,
 String paramName,
 Long defaultValue)