EntitySearchHandler (Cyclos 4.16.19 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, TransactionSearchHandler, TransferSearchHandler, UserSearchHandler
```
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 Deprecated Methods
Modifier and Type	Method	Description
`DataIterator<E>`	`exportEntities(Q query)`	Iterates entities which match the given query, applying the maximum results
`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)`	Deprecated. Will be removed in 4.17.
`com.mysema.commons.lang.CloseableIterator<Long>`	`iterateIds(Q query)`	Deprecated. Will be removed in 4.17.
`long`	`reindex()`	Reindexes all data.
`void`	`remove(Long id)`	Removes an entity by id
`Page<R>`	`search(Q query)`	Performs the search for a page of results
`Page<E>`	`searchEntities(Q query)`	Performs the search for a page of entities

- Method Detail
  - exportEntities
```
DataIterator<E> exportEntities(Q query)
```
    Iterates entities which match the given query, applying the maximum results
  - 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
```
@Deprecated
com.mysema.commons.lang.CloseableIterator<E> iterateEntities(Q query)
```
    Deprecated.
    Will be removed in 4.17. Use exportEntities(QueryParameters) instead;
    
    Iterates entities which match the given query
  - iterateIds
```
@Deprecated
com.mysema.commons.lang.CloseableIterator<Long> iterateIds(Q query)
```
    Deprecated.
    Will be removed in 4.17.
    
    Iterates ids which match the given query
  - reindex
```
long reindex()
```
    Reindexes all data. This is only called by scripts, in case the admin needs to reindex the data.
  - remove
```
void remove(Long id)
```
    Removes an entity by id
  - search
```
Page<R> search(Q query)
```
    Performs the search for a page of results
  - searchEntities
```
Page<E> searchEntities(Q query)
```
    Performs the search for a page of entities