org.openmrs.notification

Interface MessageService

All Known Implementing Classes:

MessageServiceImpl

public interface MessageService

Method Summary

Modifier and Type	Method and Description
Message	createMessage(String subject, String message)
Message	createMessage(String sender, String subject, String message)
Message	createMessage(String recipients, String sender, String subject, String message) TODO Auto generated method comment
Message	createMessage(String recipients, String sender, String subject, String message, String attachment, String attachmentContentType, String attachmentFileName)
List	getAllTemplates()
MessagePreparator	getMessagePreparator()
MessageSender	getMessageSender()
Template	getTemplate(Integer id)
List	getTemplatesByName(String name)
Message	prepareMessage(String templateName, Map data)
Message	prepareMessage(Template template)
void	sendMessage(Message message) TODO Auto generated method comment
void	sendMessage(Message message, Collection<User> users)
void	sendMessage(Message message, Integer userId)
void	sendMessage(Message message, Role role)
void	sendMessage(Message message, String roleName)
void	sendMessage(Message message, User user)
void	sendMessage(String recipients, String sender, String subject, String message)
void	setMessagePreparator(MessagePreparator preparator)
void	setMessageSender(MessageSender sender)

Method Detail

setMessageSender

void setMessageSender(MessageSender sender)

getMessageSender

MessageSender getMessageSender()

setMessagePreparator

void setMessagePreparator(MessagePreparator preparator)

getMessagePreparator

MessagePreparator getMessagePreparator()

sendMessage

void sendMessage(Message message)
          throws MessageException

TODO Auto generated method comment

Parameters:

message -

Throws:

MessageException - Should send message

sendMessage

void sendMessage(Message message,
                 String roleName)
          throws MessageException

Throws:

MessageException

sendMessage

void sendMessage(Message message,
                 Integer userId)
          throws MessageException

Throws:

MessageException

sendMessage

void sendMessage(Message message,
                 User user)
          throws MessageException

Throws:

MessageException

sendMessage

void sendMessage(Message message,
                 Role role)
          throws MessageException

Throws:

MessageException

sendMessage

void sendMessage(Message message,
                 Collection<User> users)
          throws MessageException

Throws:

MessageException

sendMessage

void sendMessage(String recipients,
                 String sender,
                 String subject,
                 String message)
          throws MessageException

Throws:

MessageException

createMessage

Message createMessage(String subject,
                      String message)
               throws MessageException

Throws:

MessageException

createMessage

Message createMessage(String sender,
                      String subject,
                      String message)
               throws MessageException

Throws:

MessageException

createMessage

Message createMessage(String recipients,
                      String sender,
                      String subject,
                      String message)
               throws MessageException

TODO Auto generated method comment

Parameters:

recipients -

sender -

subject -

message -

Returns:

Message the message that was created

Throws:

MessageException - Should create message

createMessage

Message createMessage(String recipients,
                      String sender,
                      String subject,
                      String message,
                      String attachment,
                      String attachmentContentType,
                      String attachmentFileName)
               throws MessageException

Throws:

MessageException

prepareMessage

Message prepareMessage(String templateName,
                       Map data)
                throws MessageException

Throws:

MessageException

prepareMessage

Message prepareMessage(Template template)
                throws MessageException

Throws:

MessageException

getAllTemplates

List getAllTemplates()
              throws MessageException

Throws:

MessageException

getTemplate

Template getTemplate(Integer id)
              throws MessageException

Throws:

MessageException

getTemplatesByName

List getTemplatesByName(String name)
                 throws MessageException

Throws:

MessageException