org.nuxeo.ecm.platform.query.api
Interface PageProviderService

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

PageProviderServiceImpl

public interface PageProviderService
extends java.io.Serializable

Since:

5.4

Author:

Anahide Tchertchian

Method Summary

PageProvider<?>	getPageProvider(java.lang.String name, java.util.List<SortInfo> sortInfos, java.lang.Long pageSize, java.lang.Long currentPage, java.util.Map<java.lang.String,java.io.Serializable> properties, java.lang.Object... parameters) Returns the page provider computed from the content view with given name.
PageProvider<?>	getPageProvider(java.lang.String name, PageProviderDefinition desc, java.util.List<SortInfo> sortInfos, java.lang.Long pageSize, java.lang.Long currentPage, java.util.Map<java.lang.String,java.io.Serializable> properties, java.lang.Object... parameters)
PageProviderDefinition	getPageProviderDefinition(java.lang.String name)

Method Detail

getPageProviderDefinition

PageProviderDefinition getPageProviderDefinition(java.lang.String name)

getPageProvider

PageProvider<?> getPageProvider(java.lang.String name,
                                PageProviderDefinition desc,
                                java.util.List<SortInfo> sortInfos,
                                java.lang.Long pageSize,
                                java.lang.Long currentPage,
                                java.util.Map<java.lang.String,java.io.Serializable> properties,
                                java.lang.Object... parameters)
                                throws ClientException

Throws:

ClientException

getPageProvider

PageProvider<?> getPageProvider(java.lang.String name,
                                java.util.List<SortInfo> sortInfos,
                                java.lang.Long pageSize,
                                java.lang.Long currentPage,
                                java.util.Map<java.lang.String,java.io.Serializable> properties,
                                java.lang.Object... parameters)
                                throws ClientException

Returns the page provider computed from the content view with given name. Its properties are resolved using current FacesContext instance if they are EL Expressions.

If not null, parameters sortInfos and pageSize will override information computed in the XML file. If not null, currentPage will override default current page (0).

Throws:

ClientException