Package com.axelor.search

Interface GlobalSearchService

All Known Implementing Classes:
GlobalSearchServiceImpl
public interface GlobalSearchService
The GlobalSearchService to implement global search.

  • Method Details

    • usage

      String usage()
      Get the usage help for the search (can use html).

      The usage help will be shown to the users to guide them how to use the search.

      Returns:
      the help text

    • entities

      List<String> entities()
      Get the list of entities allowed to search.
      Returns:
      list of entity names

    • filters

      List<GlobalSearchFilter> filters()
      Get list of pre-defined filters.

      If filters are not supported, return null.

      Returns:
      list of filters, or null

    • search

      GlobalSearchResult search(GlobalSearchParams params)
      Perform global search with the given params.
      Parameters:
      params - the search parameters
      Returns:
      search result