All Superinterfaces:

Serializable

All Known Implementing Classes:

PageProviderServiceImpl
```
public interface PageProviderService
extends Serializable
```
Since:

5.4

Author:

Anahide Tchertchian

Field Summary

Fields
Modifier and Type Field Description

static String NAMED_PARAMETERS
Name of the search document model context map property holding named parameters.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`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, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, List<String> highlights, List<QuickFilter> quickFilters, Object... parameters)`	Returns an instance of page provider with given name.
`PageProvider<?>`	`getPageProvider(String name, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Long currentOffset, Map<String,Serializable> properties, List<String> highlights, List<QuickFilter> quickFilters, Object... parameters)`	Returns an instance of page provider with given name.
`PageProvider<?>`	`getPageProvider(String name, DocumentModel searchDocument, 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, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, List<String> highlights, List<QuickFilter> quickFilters, Object... parameters)`	Returns an instance of page provider with given name.
`PageProvider<?>`	`getPageProvider(String name, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, List<QuickFilter> quickFilters, Object... parameters)`	Returns an instance of page provider with given name.
`PageProvider<?>`	`getPageProvider(String name, PageProviderDefinition desc, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Long currentOffset, Map<String,Serializable> properties, List<String> highlights, List<QuickFilter> quickFilters, Object... parameters)`	Returns an instance of page provider with given name and definition.
`PageProvider<?>`	`getPageProvider(String name, PageProviderDefinition desc, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, Object... parameters)`	Returns an instance of page provider with given name and definition.
`PageProvider<?>`	`getPageProvider(String name, PageProviderDefinition desc, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, List<String> highlights, List<QuickFilter> quickFilters, Object... parameters)`	Returns an instance of page provider with given name.
`PageProvider<?>`	`getPageProvider(String name, PageProviderDefinition desc, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, List<QuickFilter> quickFilters, Object... parameters)`	Returns an instance of page provider with given name.
`PageProviderDefinition`	`getPageProviderDefinition(String name)`	Returns a named page provider definition.
`Set<String>`	`getPageProviderDefinitionNames()`	Returns all the registered page provider names, or an empty set if no page provider is registered.
`PageProviderType`	`getPageProviderType(PageProvider<?> pageProvider)`	Returns the `PageProviderType` of the given page provider.
`void`	`registerPageProviderDefinition(PageProviderDefinition desc)`
`void`	`unregisterPageProviderDefinition(PageProviderDefinition desc)`

Field Detail
- NAMED_PARAMETERS
```
static final String NAMED_PARAMETERS
```
  Name of the search document model context map property holding named parameters.
  
  Since:
  
  7.1
  
  See Also:
  
  Constant Field Values

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,
                                DocumentModel searchDocument,
                                List<SortInfo> sortInfos,
                                Long pageSize,
                                Long currentPage,
                                Map<String,Serializable> properties,
                                Object... parameters)
```
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.

searchDocument - the search document to be used by the provider.

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.

Since:

5.7