All Superinterfaces:

CRUDService<BulkActionDTO,BulkActionData,BulkActionDataParams>, Service

All Known Subinterfaces:

BulkActionServiceLocal

All Known Implementing Classes:

BulkActionServiceImpl, BulkActionServiceSecurity
```
public interface BulkActionService
extends CRUDService<BulkActionDTO,BulkActionData,BulkActionDataParams>
```
Service interface for retrieving and managing bulk actions

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`cancel(@NotNull Long bulkActionId)`	Cancels a running bulk action, returning the number of users that were effectively canceled
`String`	`getErrorStackTrace(@NotNull Long bulkActionUserId)`	Returns the error stack trace for the given bulk action user.
`BulkActionsSearchData`	`getSearchData(@NotNull BulkActionUsage usage)`	Returns data for searching bulk actions for a given usage
`BulkActionSearchUsersData`	`getSearchUsersData(BulkActionDataParams params)`	Returns data for searching users to run a bulk action over them
`BulkActionStatusVO`	`getStatus(@NotNull Long id)`	Returns the current status of this bulk action counter of users for the bulk action with the given id
`Page<BulkActionVO>`	`search(@NotNull BulkActionQuery params)`	Searches for already executed bulk actions
`Page<BulkActionUserVO>`	`searchUsers(@NotNull BulkActionUserQuery params)`	Searches for users affected by a bulk action

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

Method Detail

cancel
```
int cancel(@NotNull
           @NotNull Long bulkActionId)
    throws FrameworkException
```
Cancels a running bulk action, returning the number of users that were effectively canceled

Throws:

FrameworkException

getErrorStackTrace

String getErrorStackTrace(@NotNull
                          @NotNull Long bulkActionUserId)
                   throws FrameworkException

Returns the error stack trace for the given bulk action user. If there is no error, returns null.

Throws:: FrameworkException

getSearchData

BulkActionsSearchData getSearchData(@NotNull
                                    @NotNull BulkActionUsage usage)
                             throws FrameworkException

Returns data for searching bulk actions for a given usage

Throws:: FrameworkException

getSearchUsersData

BulkActionSearchUsersData getSearchUsersData(BulkActionDataParams params)
                                      throws FrameworkException

Returns data for searching users to run a bulk action over them

Throws:: FrameworkException

getStatus

BulkActionStatusVO getStatus(@NotNull
                             @NotNull Long id)
                      throws FrameworkException

Returns the current status of this bulk action counter of users for the bulk action with the given id

Throws:: FrameworkException

search

Page<BulkActionVO> search(@NotNull
                          @NotNull BulkActionQuery params)
                   throws FrameworkException

Searches for already executed bulk actions

Throws:: FrameworkException

searchUsers

Page<BulkActionUserVO> searchUsers(@NotNull
                                   @NotNull BulkActionUserQuery params)
                            throws FrameworkException

Searches for users affected by a bulk action

Throws:: FrameworkException

Interface BulkActionService