org.phenotips.matchingnotification.notification

Interface PatientMatchNotifier

@Role
public interface PatientMatchNotifier

Send a notification per patient.

Version:

$Id: a7ccefd7288e9ed42823cf3ab259ea97b9b6e963 $

Method Summary

Modifier and Type	Method and Description
List<PatientMatchEmail>	createAdminEmailsToLocalUsers(List<PatientMatch> matches, Map<Long,List<String>> matchesIds) Build a list of emails based on the given matches.
PatientMatchEmail	createUserEmail(PatientMatch match, String subjectPatientId, String subjectServerId, String customEmailText, String customEmailSubject) Generates a email to be sent from the current user to the owner of the subjectPatientId on subjectServerId describing the given match.
List<PatientMatchNotificationResponse>	notify(PatientMatchEmail email) Sends notification for an email.

Method Detail

createAdminEmailsToLocalUsers

List<PatientMatchEmail> createAdminEmailsToLocalUsers(List<PatientMatch> matches,
                                                      Map<Long,List<String>> matchesIds)

Build a list of emails based on the given matches. One email is created for all matches with same reference patient. Can only be used to create emails for local users.

Parameters:

matches - list of matches to build emails from

matchesIds - map of ids of matches to patients Ids to be notified

Returns:

list of emails

createUserEmail

PatientMatchEmail createUserEmail(PatientMatch match,
                                  String subjectPatientId,
                                  String subjectServerId,
                                  String customEmailText,
                                  String customEmailSubject)

Generates a email to be sent from the current user to the owner of the subjectPatientId on subjectServerId describing the given match.

Parameters:

match - a match to base email text upon

subjectPatientId - the patient who's owner should receive the email

subjectServerId - the server that holds subjectpatientId. it is needed to distinguish the case when match is between patients with the same id but on different servers.

customEmailText - (optional) email text to be used

customEmailSubject - (optional) email subject to be used

Returns:

the generated email

notify

List<PatientMatchNotificationResponse> notify(PatientMatchEmail email)

Sends notification for an email.

Parameters:

email - an email to send

Returns:

list of PatientMatchNotificationResponse for the matches associated with the email