org.nuxeo.ecm.restapi.server.jaxrs.adapters

Class PaginableAdapter<T>

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<T>

All Implemented Interfaces:

AdapterResource, Resource, Adaptable

Direct Known Subclasses:

AuditAdapter, DocumentModelListPaginableAdapter

public abstract class PaginableAdapter<T>
extends DefaultAdapter

Abstract adapter to be used when one want to contribute an adapter base on PageProviders.

In order to use it, just override the getPageProviderDefinition() and getParams()

Since:

5.7.2

Constructor Summary

Constructors

Constructor and Description
PaginableAdapter()

Method Summary

Methods

Modifier and Type	Method and Description
<A> A	getAdapter(Class<A> adapter) Returns an object which is an instance of the given class associated with this object.
Paginable<T>	getPaginableEntries()

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

equals, 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

Constructor Detail

PaginableAdapter

public PaginableAdapter()

Method Detail

getAdapter

public <A> A getAdapter(Class<A> adapter)

Description copied from interface: Adaptable

Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Specified by:

getAdapter in interface Adaptable

Overrides:

getAdapter in class AbstractResource<ResourceTypeImpl>

Parameters:

adapter - the adapter class to look up

Returns:

a object castable to the given class, or null if this object does not have an adapter for the given class

getPaginableEntries

public Paginable<T> getPaginableEntries()
                                 throws ClientException

Throws:

ClientException