info.magnolia.periscope.search

Interface SearchResultSupplierDefinition

All Superinterfaces:

info.magnolia.config.NamedDefinition

All Known Implementing Classes:

AbstractSearchResultSupplierDefinition, JcrSearchResultSupplierDefinition, RestSearchResultSupplierDefinition

public interface SearchResultSupplierDefinition
extends info.magnolia.config.NamedDefinition

Definitions for Search result suppliers.

Each definition exposes its strategy via getStrategy() method which know how to construct a SearchResultSupplier from SearchResultSupplierDefinition. That method later utilised to create Search result suppliers on the fly by SearchResultSupplierDefinitionRegistry.

Method Summary

Modifier and Type	Method and Description
String	getLabel()
String	getName()
int	getResultLimit()
SearchResultSupplierStrategy	getStrategy()
boolean	isEnabled() Defines if this ResultSupplier should be enabled when performing a Periscope search.

Method Detail

isEnabled

boolean isEnabled()

Defines if this ResultSupplier should be enabled when performing a Periscope search.

Returns:

true by default

getName

String getName()

Specified by:

getName in interface info.magnolia.config.NamedDefinition

getLabel

String getLabel()

getStrategy

SearchResultSupplierStrategy getStrategy()

getResultLimit

int getResultLimit()