BulkActionServiceLocal (Cyclos 4.16.19 Scripting API Documentation)

All Superinterfaces:

BulkActionService, CRUDService<BulkActionDTO,BulkActionData,BulkActionDataParams>, CRUDServiceLocal<BulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>, Service
```
public interface BulkActionServiceLocal
extends BulkActionService, CRUDServiceLocal<BulkAction,BulkActionDTO,BulkActionData,BulkActionDataParams>
```
Local interface for BulkActionService

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`long`	`archive(long id)`	Archives the given bulk action, returning the number of relations to users removed
`static Boolean`	`getEmailRequired(AbstractUserQuery query)`
`void`	`markFinished(BulkAction bulkAction)`	Marks the given `BulkAction` as finished
`boolean`	`processNext(Long id)`	Processes the next user of the bulk action with the given id, returning whether there are more users to process or not.
`static void`	`setEmailRequired(AbstractUserQuery query)`

Methods inherited from interface org.cyclos.services.users.BulkActionService
cancel, getErrorStackTrace, getSearchData, getSearchUsersData, getStatus, previewMailingList, search, searchUsers, sendTestApp, sendTestEmail, sendTestSms

Methods inherited from interface org.cyclos.services.CRUDService
getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal
find, findAll, getEntityClass, newEntity, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

- Method Detail
  - getEmailRequired
```
static Boolean getEmailRequired(AbstractUserQuery query)
```
  - setEmailRequired
```
static void setEmailRequired(AbstractUserQuery query)
```
  - archive
```
long archive(long id)
```
    Archives the given bulk action, returning the number of relations to users removed
  - markFinished
```
void markFinished(BulkAction bulkAction)
```
    Marks the given BulkAction as finished
  - processNext
```
boolean processNext(Long id)
```
    Processes the next user of the bulk action with the given id, returning whether there are more users to process or not. Assumes there is no current transaction, as it will need 1 or 2 transactions to run: one to execute and another one if there's an error