public interface PageProviderService extends Serializable
Modifier and Type | Method and Description |
---|---|
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,
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,
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,
List<SortInfo> sortInfos,
Long pageSize,
Long currentPage,
Map<String,Serializable> properties,
Object... parameters)
Deprecated.
since 5.7: use
getPageProvider(String, PageProviderDefinition, DocumentModel, List, Long, Long, Map, Object...)
with search document model as additional parameter |
PageProviderDefinition |
getPageProviderDefinition(String name)
Returns a named page provider definition.
|
PageProviderDefinition getPageProviderDefinition(String name)
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).
name
- the page provider name@Deprecated PageProvider<?> getPageProvider(String name, PageProviderDefinition desc, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, Object... parameters) throws ClientException
getPageProvider(String, PageProviderDefinition, DocumentModel, List, Long, Long, Map, Object...)
with search document model as additional parameterClientException
PageProvider<?> getPageProvider(String name, PageProviderDefinition desc, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, Object... parameters) throws ClientException
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).
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 propertiesparameters
- the provider parameters.ClientException
- if the page provider instantiation fails.PageProvider<?> getPageProvider(String name, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, Object... parameters) throws ClientException
name
- the page provider namesortInfos
- sort information to set on the provider instance.pageSize
- the provider page size.currentPage
- the provider current page index.properties
- the provider propertiesparameters
- the provider parameters.ClientException
- if the page provider instantiation fails.PageProvider<?> getPageProvider(String name, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, Object... parameters) throws ClientException
ClientException
- if the page provider instantiation fails.getPageProvider(String, PageProviderDefinition, DocumentModel,
List, Long, Long, Map, Object...)
Copyright © 2013 Nuxeo SA. All Rights Reserved.