de.espirit.firstspirit.access.search

Interface SearchService

public interface SearchService

Please consider using QueryAgent.

Service interface for searching within FIRSTspirit.

Use getService(SearchService.class) to request an instance of this service.

Since:

4.0.17

See Also:

ServicesBroker.getService(Class)

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getSuggestions(Long projectId, String word, Language language) Suggest indexed words matching the given one.
de.espirit.firstspirit.access.search.ResultProvider	search(Project project, Request request) Initiates a search on data with the given request.
Iterable<Task>	searchTasks(Long projectId, de.espirit.firstspirit.access.search.TaskQuery query) Deprecated. since 4.1.10 - no replacement

Method Detail

search

de.espirit.firstspirit.access.search.ResultProvider search(Project project,
                                                         Request request)

Initiates a search on data with the given request. Returns a provider which can be requested for results.

Parameters:

project - The project to search in

request - The request to find matches for.

Returns:

The search's result provider.

Since:

4.1.141

getSuggestions

@NotNull
List<String> getSuggestions(Long projectId,
                                  String word,
                                  Language language)

Suggest indexed words matching the given one.

Parameters:

projectId - The project id.

word - The word to look up matches for.

language - The to look up matches for.

Returns:

A list of matching words.

Since:

5.0

searchTasks

@Deprecated
Iterable<Task> searchTasks(Long projectId,
                                    de.espirit.firstspirit.access.search.TaskQuery query)

Deprecated. since 4.1.10 - no replacement

Get filtered list of tasks. The returned tasks are ordered by task id.

Parameters:

projectId - The id of the project.

query - the query object selecting the tasks to return

Returns:

the returned tasks

Since:

4.0.120