Package com.axelor.search.impl

Class GlobalSearchServiceImpl

java.lang.Object

com.axelor.search.impl.GlobalSearchServiceImpl

All Implemented Interfaces:

GlobalSearchService

public class GlobalSearchServiceImpl
extends Object
implements GlobalSearchService

Constructor Summary

Constructors

Constructor	Description
GlobalSearchServiceImpl()

Method Summary

Modifier and Type	Method	Description
List<String>	entities()	Get the list of entities allowed to search.
List<GlobalSearchFilter>	filters()	Get list of pre-defined filters.
GlobalSearchResult	search(GlobalSearchParams params)	Perform global search with the given params.
String	usage()	Get the usage help for the search (can use html).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GlobalSearchServiceImpl

public GlobalSearchServiceImpl()

Method Details

usage

public String usage()

Description copied from interface: GlobalSearchService

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.

Specified by:

usage in interface GlobalSearchService

Returns:

the help text

filters

public List<GlobalSearchFilter> filters()

Description copied from interface: GlobalSearchService

Get list of pre-defined filters.

If filters are not supported, return null.

Specified by:

filters in interface GlobalSearchService

Returns:

list of filters, or null

entities

public List<String> entities()

Description copied from interface: GlobalSearchService

Get the list of entities allowed to search.

Specified by:

entities in interface GlobalSearchService

Returns:

list of entity names

search

public GlobalSearchResult search(GlobalSearchParams params)

Description copied from interface: GlobalSearchService

Perform global search with the given params.

Specified by:

search in interface GlobalSearchService

Parameters:

params - the search parameters

Returns:

search result