org.xwiki.extension.repository.search

Interface Searchable

All Known Subinterfaces:

AdvancedSearchable, CoreExtensionRepository, ExtensionIndex, ExtensionRepositoryManager, InstalledExtensionRepository, LocalExtensionRepository, SearchableExtensionRepository

All Known Implementing Classes:

AbstractAdvancedSearchableExtensionRepository, AbstractFilteredExtensionRepository

public interface Searchable

A repository can implements it to provide basic search capabilities.

Since:

4.0M1

Version:

$Id: 95e30244ddb74f61315d306f62a8b5eb28ff124c $

See Also:

AdvancedSearchable

Method Summary

Modifier and Type	Method and Description
IterableResult<Extension>	search(String pattern, int offset, int nb) Search extension based of the provided pattern.

Method Detail

search

IterableResult<Extension> search(String pattern,
                                 int offset,
                                 int nb)
                          throws SearchException

Search extension based of the provided pattern.

The pattern is a simple character chain.

Parameters:

pattern - the pattern to search

offset - the offset from where to start returning search results

nb - the maximum number of search results to return

Returns:

the found extensions descriptors, empty list if nothing could be found

Throws:

SearchException - error when trying to search provided pattern