org.phenotips.matchingnotification

Interface MatchingNotificationManager

@Role
public interface MatchingNotificationManager

Version:

$Id: 3fc6730ef70a63e570b11be2bf99d531d28e251c $

Method Summary

Modifier and Type	Method and Description
boolean	addNote(Set<Long> matchesIds, String note) Saves note to all matches with ids in matchesIds.
org.json.JSONObject	getUserEmailContent(Long matchId, String subjectPatientId, String subjectServerId) Returns the contents of the email that will be send as a notification for match with the given id, with the recepient being the owner of the given patient on the given server.
List<PatientMatch>	saveComment(Set<Long> matchesIds, String comment) Saves comment to all matches with ids in matchesIds to a passed comment string.
boolean	saveIncomingMatches(List<? extends PatientSimilarityView> similarityViews, String patientId, String remoteId) Saves a list of matches that were found by a remote incoming request.
boolean	saveOutgoingMatches(List<? extends PatientSimilarityView> similarityViews, String patientId, String remoteId) Saves a list of matches that were found by a remote outgoing request.
List<PatientMatchNotificationResponse>	sendAdminNotificationsToLocalUsers(Map<Long,List<String>> idsList) Sends notification to the owner of every match with id in matchesId, then marks match as notified.
PatientMatchNotificationResponse	sendUserNotification(Long matchId, String subjectPatientId, String subjectServerId, String customEmailText, String customEmailSubject) Sends notification to the owner of the suvbjectpatientId about the given match.
boolean	setNotifiedStatus(Set<Long> matchesIds, boolean isNotified) Marks all matches with ids in matchesIds as notified or not notified.
boolean	setStatus(Set<Long> matchesIds, String status) Sets status to all matches with ids in matchesIds to a passed status string.
boolean	setUserContacted(Set<Long> matchesIds, boolean isUserContacted) Marks all matches with ids in matchesIds as user-contacted or not.

Method Detail

sendAdminNotificationsToLocalUsers

List<PatientMatchNotificationResponse> sendAdminNotificationsToLocalUsers(Map<Long,List<String>> idsList)

Sends notification to the owner of every match with id in matchesId, then marks match as notified.

Parameters:

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

Returns:

a list of PatientmatchNotificationResponse

sendUserNotification

PatientMatchNotificationResponse sendUserNotification(Long matchId,
                                                      String subjectPatientId,
                                                      String subjectServerId,
                                                      String customEmailText,
                                                      String customEmailSubject)

Sends notification to the owner of the suvbjectpatientId about the given match.

Parameters:

matchId - match id

subjectPatientId - the id of the patient that is the subject of the email (can be either of the two patients involved in the specified match)

subjectServerId - the id of the server that holds the given patient. Is only needed to distinguish two patients with the same ID

customEmailText - (optional) email text to be used

customEmailSubject - (optional) emial subject to be used

Returns:

status of the notification as PatientMatchNotificationResponse

getUserEmailContent

org.json.JSONObject getUserEmailContent(Long matchId,
                                        String subjectPatientId,
                                        String subjectServerId)

Returns the contents of the email that will be send as a notification for match with the given id, with the recepient being the owner of the given patient on the given server.

Parameters:

matchId - match id

subjectPatientId - the id of the patient that is the subject of the email (can be either of the two patients involved in the specified match)

subjectServerId - the id of the server that holds the given patient. Is only needed to distinguish two patients with the same ID

Returns:

a response containing a JSON object, in the following format:

      { "emailContent": text,
        "recipients": { "to": list_of_email_addresses_as_strings, "from": list, "cc": list },
        "contentType": type,
        "subject": text }
     

where text is a string, and type the type of content as string (e.g. "text/plain")

saveIncomingMatches

boolean saveIncomingMatches(List<? extends PatientSimilarityView> similarityViews,
                            String patientId,
                            String remoteId)

Saves a list of matches that were found by a remote incoming request.

Parameters:

similarityViews - list of similarity views

patientId - remote patient ID for whom to save matches (needed only to know which existing matches to remove/replace)

remoteId - id of remote server which sent the incoming request and houses the given patient

Returns:

true if successful

saveOutgoingMatches

boolean saveOutgoingMatches(List<? extends PatientSimilarityView> similarityViews,
                            String patientId,
                            String remoteId)

Saves a list of matches that were found by a remote outgoing request.

Parameters:

similarityViews - list of similarity views

patientId - local patient ID for whom to save matches (needed only to know which existing matches to remove/replace)

remoteId - id of remote server contacted to find matches for the given local patient

Returns:

true if successful

setStatus

boolean setStatus(Set<Long> matchesIds,
                  String status)

Sets status to all matches with ids in matchesIds to a passed status string.

Parameters:

matchesIds - list of ids of matches to set status

status - whether matches should be set as saved, rejected or uncategorized

Returns:

true if successful

setNotifiedStatus

boolean setNotifiedStatus(Set<Long> matchesIds,
                          boolean isNotified)

Marks all matches with ids in matchesIds as notified or not notified.

Parameters:

matchesIds - list of ids of matches to mark as notified.

isNotified - boolean notified status to set for matches

Returns:

true if successful

setUserContacted

boolean setUserContacted(Set<Long> matchesIds,
                         boolean isUserContacted)

Marks all matches with ids in matchesIds as user-contacted or not.

Parameters:

matchesIds - list of ids of matches to mark as user-contacted.

isUserContacted - boolean user-contacted status to set for matches

Returns:

true if successful

saveComment

List<PatientMatch> saveComment(Set<Long> matchesIds,
                               String comment)

Saves comment to all matches with ids in matchesIds to a passed comment string.

Parameters:

matchesIds - list of ids of matches to save comment

comment - comment text

Returns:

list of updated matches

addNote

boolean addNote(Set<Long> matchesIds,
                String note)

Saves note to all matches with ids in matchesIds.

Parameters:

matchesIds - list of ids of matches to save note to

note - note text

Returns:

true if successful