Package ch.tocco.nice2.netui.api.bind.entity

Interface SearchService

All Known Implementing Classes:

SearchServiceImpl

public interface SearchService

The search service is used from the client through DWR.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SearchService.AbstractSearchParameters
static class	SearchService.SearchParameters

Method Summary

Modifier and Type	Method	Description
Query	createSearchQuery(SearchService.SearchParameters searchParameters, FulltextSearchBuilder.SearchScope searchScope)	generates a query from parameters that can be used to start a search
String	generateSearchQueryString(SearchService.SearchParameters searchParameters)
@Nullable Map<String,String>	getDefaultSearchFilters()
Row	loadRow(Entity entity, boolean skipDefaultDisplay, Iterable<Column> visibleColumns)
@Nullable Row	loadRow(String key, String entityModel, boolean skipDefaultDisplay, String formName, List<String> visibleColumns)
DetailedGridResultData	relationSearch(SearchService.SearchParameters relationSearchParameters)	This is used for the relations grid where all objects in relation to another record are shown.
PrimaryKey[]	relationSearchForKeys(SearchService.SearchParameters relationSearchParameters)	Returns the primary keys of all that match.
DetailedGridResultData	search(SearchService.SearchParameters searchParameters)	Finds records for showing them in a data grid.
PrimaryKey[]	searchForKeys(SearchService.SearchParameters searchParameters)	Returns the primary keys of all that match.
DetailedGridResultData	searchForRemoteField(SearchService.SearchParameters searchParameters)

Method Details

search

DetailedGridResultData search(SearchService.SearchParameters searchParameters)
                       throws PersistException,
RpcExecutionException

Finds records for showing them in a data grid. This is used for search forms, search filters, and combinations of both.

Throws:

PersistException

RpcExecutionException

searchForRemoteField

DetailedGridResultData searchForRemoteField(SearchService.SearchParameters searchParameters)
                                     throws PersistException,
RpcExecutionException

Throws:

PersistException

RpcExecutionException

getDefaultSearchFilters

@Nullable
@Nullable Map<String,String> getDefaultSearchFilters()
                                              throws PersistException

Throws:

PersistException

searchForKeys

PrimaryKey[] searchForKeys(SearchService.SearchParameters searchParameters)
                    throws PersistException,
RpcExecutionException

Returns the primary keys of all that match. No order, no offset/limit.

Throws:

PersistException

RpcExecutionException

relationSearch

DetailedGridResultData relationSearch(SearchService.SearchParameters relationSearchParameters)
                               throws PersistException,
RpcExecutionException

This is used for the relations grid where all objects in relation to another record are shown.

Example: all addresses for a person.

Throws:

PersistException

RpcExecutionException

relationSearchForKeys

PrimaryKey[] relationSearchForKeys(SearchService.SearchParameters relationSearchParameters)
                            throws PersistException,
RpcExecutionException

Returns the primary keys of all that match. No order, no offset/limit.

Throws:

PersistException

RpcExecutionException

generateSearchQueryString

String generateSearchQueryString(SearchService.SearchParameters searchParameters)
                          throws PersistException,
RpcExecutionException

Throws:

PersistException

RpcExecutionException

loadRow

Row loadRow(Entity entity,
 boolean skipDefaultDisplay,
 Iterable<Column> visibleColumns)
     throws RpcExecutionException,
PersistException

Throws:

RpcExecutionException

PersistException

loadRow

@Nullable
@Nullable Row loadRow(String key,
 String entityModel,
 boolean skipDefaultDisplay,
 String formName,
 List<String> visibleColumns)
               throws RpcExecutionException,
PersistException

Throws:

RpcExecutionException

PersistException

createSearchQuery

Query createSearchQuery(SearchService.SearchParameters searchParameters,
 FulltextSearchBuilder.SearchScope searchScope)

generates a query from parameters that can be used to start a search

Parameters:

searchParameters - the parameters to generate the query from

searchScope - the scope to generate the query for

Returns:

the finished query