UserSearchHandler (Cyclos 4.15.15 Scripting API Documentation)

All Superinterfaces:

EntitySearchHandler<User,UserQuery,UserWithFieldsVO>, RemovableEntitySearchHandler<User,UserQuery,UserWithFieldsVO>

All Known Implementing Classes:

ElasticsearchUserSearchHandlerImpl, PostgresqlUserSearchHandlerImpl
```
public interface UserSearchHandler
extends RemovableEntitySearchHandler<User,UserQuery,UserWithFieldsVO>
```
Interface for searching users

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`UsersWithBalancesOverview`	`getBalancesOverview(UserWithBalanceQuery params)`	Returns an overview with summaries for all matching balances
`com.mysema.commons.lang.CloseableIterator<UserWithBalanceVO>`	`iterateWithBalances(UserWithBalanceQuery params)`	Returns an iterator of users with their respective balances
`void`	`onBrokerChange(User user)`	Callback used to update the broker references for the given user
`void`	`onGroupChange(User user)`	Callback used to update the group reference for the given user
`Page<UserWithBalanceVO>`	`searchWithBalances(UserWithBalanceQuery params)`	Searches users with their respective balances
`void`	`updateBalances(Map<UserAccount,AccountStatusUpdateResult> updates)`	Updates all the given account fields
`void`	`updateLastLogin(User user, Date lastLogin)`	Updates the last login of the given user
`void`	`updateUserFields(User user)`	Updates the user fields which can also affect searches on related data, such as advertisements and records.

Methods inherited from interface org.cyclos.impl.search.EntitySearchHandler
index, indexName, iterateEntities, iterateIds, reindex, search

Methods inherited from interface org.cyclos.impl.search.RemovableEntitySearchHandler
remove

- Method Detail
  - getBalancesOverview
```
UsersWithBalancesOverview getBalancesOverview(UserWithBalanceQuery params)
```
    Returns an overview with summaries for all matching balances
  - iterateWithBalances
```
com.mysema.commons.lang.CloseableIterator<UserWithBalanceVO> iterateWithBalances(UserWithBalanceQuery params)
```
    Returns an iterator of users with their respective balances
  - onBrokerChange
```
void onBrokerChange(User user)
```
    Callback used to update the broker references for the given user
  - onGroupChange
```
void onGroupChange(User user)
```
    Callback used to update the group reference for the given user
  - searchWithBalances
```
Page<UserWithBalanceVO> searchWithBalances(UserWithBalanceQuery params)
```
    Searches users with their respective balances
  - updateBalances
```
void updateBalances(Map<UserAccount,AccountStatusUpdateResult> updates)
```
    Updates all the given account fields
  - updateLastLogin
```
void updateLastLogin(User user,
                     Date lastLogin)
```
    Updates the last login of the given user
  - updateUserFields
```
void updateUserFields(User user)
```
    Updates the user fields which can also affect searches on related data, such as advertisements and records. The affected data is, for example, group, brokers, status and profile fields.