public interface PageProviderService extends Serializable
Modifier and Type | Field and Description |
---|---|
static String |
NAMED_PARAMETERS
Name of the search document model context map property holding named parameters.
|
Modifier and Type | Method and Description |
---|---|
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,
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<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,
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,
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,
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,
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<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,
Object... parameters)
Returns an instance of page provider with given name and definition.
|
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.
|
void |
registerPageProviderDefinition(PageProviderDefinition desc) |
void |
unregisterPageProviderDefinition(PageProviderDefinition desc) |
static final String NAMED_PARAMETERS
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 namePageProvider<?> getPageProvider(String name, PageProviderDefinition desc, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, Object... parameters)
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.PageProvider<?> getPageProvider(String name, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, Object... parameters)
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.PageProvider<?> getPageProvider(String name, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, Object... parameters)
PageProvider<?> getPageProvider(String name, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, List<QuickFilter> quickFilters, Object... parameters)
getPageProvider(String, DocumentModel, List, Long, Long, Map, Object...)
PageProvider<?> getPageProvider(String name, PageProviderDefinition desc, DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, List<QuickFilter> quickFilters, Object... parameters)
PageProvider<?> getPageProvider(String name, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Map<String,Serializable> properties, List<String> highlights, List<QuickFilter> quickFilters, Object... parameters)
getPageProvider(String, List, Long, Long, Map, Object...)
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)
getPageProvider(String, DocumentModel, List, Long, Long, Map, Object...)
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)
name
- the name that will be set on the provider.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. Ignored if currentOffset set.currentOffset
- the provider current offset.properties
- the provider properties.highlights
- list of the fields to be highlighted.quickFilters
- list of the quickFilters to be applied.parameters
- the provider parameters.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)
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)
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. Ignored if currentOffset set.currentOffset
- the provider current page offset.properties
- the provider properties.highlights
- list of the fields to be highlighted.quickFilters
- list of the quickFilters to be applied.parameters
- the provider parameters.void registerPageProviderDefinition(PageProviderDefinition desc)
void unregisterPageProviderDefinition(PageProviderDefinition desc)
Set<String> getPageProviderDefinitionNames()
Copyright © 2018 Nuxeo. All rights reserved.