org.phenotips.matchingnotification.notification

Interface PatientMatchEmail

public interface PatientMatchEmail

Version:

$Id: ab598d98e01fdf1ff7e875514a7f28dbef20502d $

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	getEmail() Get email data (body, subject, recipients) in a JSON format.
Collection<PatientMatch>	getMatches()
org.xwiki.mail.MailStatus	getStatus()
String	getSubjectPatientId()
void	send() Send the email.
boolean	wasSent()

Method Detail

getSubjectPatientId

String getSubjectPatientId()

Returns:

the id of the patient about whom the email was sent. It is always local.

getMatches

Collection<PatientMatch> getMatches()

Returns:

the matches this email notifies of.

wasSent

boolean wasSent()

Returns:

true if email was sent.

getStatus

org.xwiki.mail.MailStatus getStatus()

Returns:

status result of email sending. Null if email was not sent.

send

void send()

Send the email.

getEmail

org.json.JSONObject getEmail()

Get email data (body, subject, recipients) in a JSON format.

Returns:

JSONObject in the

      { "emailContent": text,
        "recipients": [listof email addresses as strings],
        "contentType": type,
        "subject": text }
     

format.