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

All Superinterfaces:

Serializable

All Known Implementing Classes:

PageProviderServiceImpl

public interface PageProviderService
extends Serializable

Since:

5.4

Author:

Anahide Tchertchian

Method Summary

PageProvider<?>	getPageProvider(String name, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, Object... parameters) Returns an instance of page provider with given name.
PageProvider<?>	getPageProvider(String name, PageProviderDefinition desc, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, Object... parameters) Returns an instance of page provider with given name and definition.
PageProviderDefinition	getPageProviderDefinition(String name) Returns a named page provider definition.

Method Detail

getPageProviderDefinition

PageProviderDefinition getPageProviderDefinition(String name)

Returns a named page provider definition.

Useful to share the definition between the page provider service, and the content view service (as content views can reference a named page provider that is already registered instead of redefining it).

Parameters:

name - the page provider name

Returns:

the page provider definition or null, if no page provider with this name was found.

Since:

5.4

getPageProvider

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

Returns an instance of page provider with given name and definition.

Useful to share the definition between the page provider service, and the content view service (as content views can reference a named page provider that is already registered instead of redefining it).

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).

Parameters:

name - the name that will be set on the provider.

desc - the definition used to build the provider instance.

sortInfos - sort information to set on the provider instance.

pageSize - the provider page size.

currentPage - the provider current page index.

properties - the provider properties

parameters - the provider parameters.

Returns:

the page provider instance.

Throws:

ClientException - if the page provider instantiation fails.

Since:

5.4

getPageProvider

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

Returns an instance of page provider with given name.

Throws:

ClientException

See Also:

getPageProvider(String, PageProviderDefinition, List, Long, Long, Map, Object...)