EntitySearchHandler (Cyclos 4.14.14 Scripting API Documentation)

Type Parameters:

E - The entity type

Q - The query parameters type

R - The result type on search, generally a VO

All Known Subinterfaces:

AdSearchHandler, ContactSearchHandler, InstallmentSearchHandler, RecordSearchHandler, RemovableEntitySearchHandler<E,Q,R>, TransactionSearchHandler, TransferSearchHandler, UserSearchHandler

All Known Implementing Classes:

BasePostgresqlEntitySearchHandlerImpl, ElasticsearchAdSearchHandlerImpl, ElasticsearchBaseTransactionSearchHandlerImpl, ElasticsearchEntitySearchHandlerImpl, ElasticsearchInstallmentSearchHandlerImpl, ElasticsearchRecordSearchHandlerImpl, ElasticsearchTransactionSearchHandlerImpl, ElasticsearchTransferSearchHandlerImpl, ElasticsearchTransSearchHandlerImpl, ElasticsearchUserSearchHandlerImpl, PostgresqlAdSearchHandlerImpl, PostgresqlContactSearchHandlerImpl, PostgresqlInstallmentSearchHandlerImpl, PostgresqlRecordSearchHandlerImpl, PostgresqlTransactionSearchHandlerImpl, PostgresqlTransferSearchHandlerImpl, PostgresqlUserSearchHandlerImpl
```
public interface EntitySearchHandler<E extends NetworkedEntity,Q extends QueryParameters,R>
```
Interface for searching over a specific entity

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`index(E entity)`	Indexes the given entity
`String`	`indexName()`	Returns the name of the external index, or null if external indexing isn't used
`com.mysema.commons.lang.CloseableIterator<E>`	`iterateEntities(Q query)`	Iterates entities which match the given query
`com.mysema.commons.lang.CloseableIterator<Long>`	`iterateIds(Q query)`	Iterates ids which match the given query
`void`	`reindex()`	Reindexes all data.
`Page<R>`	`search(Q query)`	Performs the search for a page of results

- Method Detail
  - index
```
void index(E entity)
```
    Indexes the given entity
  - indexName
```
String indexName()
```
    Returns the name of the external index, or null if external indexing isn't used
  - iterateEntities
```
com.mysema.commons.lang.CloseableIterator<E> iterateEntities(Q query)
```
    Iterates entities which match the given query
  - iterateIds
```
com.mysema.commons.lang.CloseableIterator<Long> iterateIds(Q query)
```
    Iterates ids which match the given query
  - reindex
```
void reindex()
```
    Reindexes all data. This is only called by scripts, in case the admin needs to reindex the data.
  - search
```
Page<R> search(Q query)
```
    Performs the search for a page of results