SearchEngine (Silverpeas Core 6.3 API)

All Known Implementing Classes:

SimpleSearchEngine
```
public interface SearchEngine
```
A SearchEngine search the web'activ index and give access to the retrieved index entries.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`PlainSearchResult`	`search(QueryDescription query)`	Search the index for the required documents.
`Set<String>`	`suggestKeywords(String keywordFragment)`	gets a list of suggestion from a partial String

- Method Detail
  - search
```
PlainSearchResult search(QueryDescription query)
                  throws ParseException
```
    Search the index for the required documents.
    If QueryDescription.setAdminScope(boolean) as been called with a true value (it MUST be only set by administration features), no filtering is performed on index search result.
    
    In other context than the one of administration scope, a filtering is performed on the index search result. The filtering is using ComponentAuthorization API which permits each component to apply theirs access security rules.
    
    Parameters:
    
    query - the search query.
    
    Returns:
    
    the results.
    
    Throws:
    
    ParseException
  - suggestKeywords
```
Set<String> suggestKeywords(String keywordFragment)
```
    gets a list of suggestion from a partial String
    
    Parameters:
    
    keywordFragment - string to execute the search
    
    Returns:
    
    a set of result sorted by alphabetic order