org.cyclos.services.messaging

Interface MailingListService

All Superinterfaces:

Service

All Known Subinterfaces:

MailingListServiceLocal

All Known Implementing Classes:

MailingListServiceSecurity

public interface MailingListService
extends Service

Method Summary

Modifier and Type	Method and Description
MailingListSearchData	getSearchData() Returns data for searching Mailing lists.
SendMailingListData	getSendData(@NotNull MailingListType type) Returns data for sending a mailing list with the specified type.
MailingListDetailedVO	load(@NotNull java.lang.Long id) Loads a mailing list by id
Page<MailingListVO>	search(@NotNull MailingListQuery query) Searches for Mailing list according to the given criteria.
int	send(@NotNull SendMailingListDTO object) Sends a message to the specified recipients (groups/users) and return the total of users that will receive the message.

Method Detail

getSearchData

MailingListSearchData getSearchData()
                             throws FrameworkException

Returns data for searching Mailing lists.

Throws:

FrameworkException

getSendData

SendMailingListData getSendData(@NotNull
                                @NotNull MailingListType type)
                         throws FrameworkException

Returns data for sending a mailing list with the specified type.

Throws:

FrameworkException

load

MailingListDetailedVO load(@NotNull
                           @NotNull java.lang.Long id)
                    throws FrameworkException

Loads a mailing list by id

Throws:

FrameworkException

search

Page<MailingListVO> search(@NotNull
                           @NotNull MailingListQuery query)
                    throws FrameworkException

Searches for Mailing list according to the given criteria.

Throws:

FrameworkException

send

int send(@NotNull
         @NotNull SendMailingListDTO object)
  throws FrameworkException

Sends a message to the specified recipients (groups/users) and return the total of users that will receive the message.

Throws:

FrameworkException