Package 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:

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull List<String>
    getSuggestions(long projectId, @NotNull String indexField, @NotNull String word, @Nullable Language language)
    Suggest indexed words matching the given one.
    @NotNull List<String>
    getSuggestions(Long projectId, @NotNull String word, @Nullable 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 Details

    • 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 @NotNull List<String> getSuggestions(Long projectId, @NotNull @NotNull String word, @Nullable @Nullable Language language)
      Suggest indexed words matching the given one.
      Parameters:
      projectId - The project id.
      word - The word to look up matches for, must not be null.
      language - The language to look up matches for, or null for language independent fields.
      Returns:
      A list of matching words.
      Since:
      5.0

    • getSuggestions

      @NotNull @NotNull List<String> getSuggestions(long projectId, @NotNull @NotNull String indexField, @NotNull @NotNull String word, @Nullable @Nullable Language language)
      Suggest indexed words matching the given one.
      Parameters:
      projectId - The project id.
      indexField - The index field to look up matches for, must not be null.
      word - The word to look up matches for, must not be null.
      language - The language to look up matches for, or null for language independent fields.
      Returns:
      A list of matching words. May be empty but never null.
      Since:
      5.2.180704

    • 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