Package org.cyclos.services.users

Interface BulkActionService

All Superinterfaces:

CRUDService<BulkActionDTO,BulkActionData,BulkActionDataParams>, Service

All Known Subinterfaces:

BulkActionServiceLocal

public interface BulkActionService
extends CRUDService<BulkActionDTO,BulkActionData,BulkActionDataParams>

Service interface for retrieving and managing bulk actions

Method Summary

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
MailingListPreviewData	previewMailingList(@NotNull BulkActionDTO dto, UserVO previewUser)	Previews a mailing list, filling up variables using the given user.
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
boolean	sendTestApp(AppMailingBulkActionDTO dto, UserVO previewUser, UserVO toUser)	Sends a test App Push Notification for the given bulk action to the given user.
boolean	sendTestEmail(EmailMailingBulkActionDTO dto, UserVO previewUser, String toEmail)	Sends a test e-mail for the given bulk action to the given e-mail address
SendSMSResult	sendTestSms(SmsMailingBulkActionDTO dto, UserVO previewUser, String toPhone)	Sends a test SMS for the given bulk action to the given mobile phone number.

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

previewMailingList

MailingListPreviewData previewMailingList(@NotNull
                                          @NotNull BulkActionDTO dto,
                                          UserVO previewUser)
                                   throws FrameworkException

Previews a mailing list, filling up variables using the given user. When no user is passed in, will get the first user in the query.

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

sendTestApp

boolean sendTestApp(AppMailingBulkActionDTO dto,
                    UserVO previewUser,
                    UserVO toUser)
             throws FrameworkException

Sends a test App Push Notification for the given bulk action to the given user.

Returns:

whether or not the app notification could be sent

Throws:

FrameworkException

sendTestEmail

boolean sendTestEmail(EmailMailingBulkActionDTO dto,
                      UserVO previewUser,
                      String toEmail)
               throws FrameworkException

Sends a test e-mail for the given bulk action to the given e-mail address

Returns:

whether or not the email could be sent

Throws:

FrameworkException

sendTestSms

SendSMSResult sendTestSms(SmsMailingBulkActionDTO dto,
                          UserVO previewUser,
                          String toPhone)
                   throws FrameworkException

Sends a test SMS for the given bulk action to the given mobile phone number.

Returns:

whether or not the SMS could be sent (never null)

Throws:

FrameworkException