org.nuxeo.ecm.restapi.server.jaxrs

Class PaginableObject<T>

java.lang.Object

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

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

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

All Implemented Interfaces:

org.nuxeo.ecm.webengine.model.Resource, Adaptable

Direct Known Subclasses:

AbstractUMRootObject

public abstract class PaginableObject<T>
extends org.nuxeo.ecm.webengine.model.impl.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 and Description
protected Long	currentPageIndex
protected String	maxResults
protected Long	pageSize

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

ctx, next, path, prev, type

Constructor Summary

Constructors

Constructor and Description
PaginableObject()

Method Summary

Modifier and Type	Method and Description
protected Long	extractLongParam(javax.servlet.http.HttpServletRequest request, String paramName, Long defaultValue)
protected abstract org.nuxeo.ecm.platform.query.api.PageProviderDefinition	getPageProviderDefinition()
org.nuxeo.ecm.automation.core.util.Paginable<T>	getPaginableEntries()
protected org.nuxeo.ecm.automation.core.util.Paginable<T>	getPaginableEntries(org.nuxeo.ecm.platform.query.api.PageProvider<T> pageProvider)
protected Object[]	getParams()
protected org.nuxeo.ecm.core.api.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, redirect, setNext, setPrevious, setRoot, toString

Methods inherited from class java.lang.Object

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

Field Detail

currentPageIndex

protected Long currentPageIndex

pageSize

protected Long pageSize

maxResults

protected String maxResults

Constructor Detail

PaginableObject

public PaginableObject()

Method Detail

initialize

protected void initialize(Object... args)

Overrides:

initialize in class org.nuxeo.ecm.webengine.model.impl.AbstractResource<org.nuxeo.ecm.webengine.model.impl.ResourceTypeImpl>

getPageProviderDefinition

protected abstract org.nuxeo.ecm.platform.query.api.PageProviderDefinition getPageProviderDefinition()

getParams

protected Object[] getParams()

getSearchDocument

protected org.nuxeo.ecm.core.api.DocumentModel getSearchDocument()
                                                          throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

getPaginableEntries

public org.nuxeo.ecm.automation.core.util.Paginable<T> getPaginableEntries()
                                                                    throws org.nuxeo.ecm.core.api.ClientException

Throws:

org.nuxeo.ecm.core.api.ClientException

getPaginableEntries

protected org.nuxeo.ecm.automation.core.util.Paginable<T> getPaginableEntries(org.nuxeo.ecm.platform.query.api.PageProvider<T> pageProvider)

extractLongParam

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