org.xwiki.extension.repository.search
Interface Searchable

All Known Subinterfaces:

CoreExtensionRepository, InstalledExtensionRepository, LocalExtensionRepository

public interface Searchable

A repository can implements it to provide search capabilities.

Since:

4.0M1

Version:

$Id: 3bc9752d90049d7ff8d9e95a4d86e48135939b78 $

Method Summary

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