org.phenotips.matchingnotification

Interface MatchingNotificationManager

@Role
public interface MatchingNotificationManager

Version:

$Id: 370edc2d43d6fe03748f14adc4e661f8ad0db535 $

Method Summary

Modifier and Type	Method and Description
PatientMatch	addNote(Long matchId, String note) Saves note for a match that has the given matchId internal ID.
PatientMatch	getMatch(Long matchId) Returns a match that has the given matchId internal ID.
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 recipient being the owner of the given patient on the given server.
PatientMatch	saveComment(Long matchId, String comment) Saves comment for a match that has the given matchId internal ID.
List<PatientMatch>	saveIncomingMatches(List<? extends PatientSimilarityView> similarityViews, String patientId, String remoteId) Saves a list of matches that were found by a remote incoming request.
List<PatientMatch>	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.
PatientMatch	setStatus(Long matchId, String status) Sets status for a match that has the given matchId internal ID.
PatientMatch	setUserContacted(Long matchId, 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) email 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 recipient 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

List<PatientMatch> 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:

null if saving failed, otherwise list of saved PatientMatches

saveOutgoingMatches

List<PatientMatch> 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:

null if saving failed, otherwise list of saved PatientMatches

setStatus

PatientMatch setStatus(Long matchId,
                       String status)
                throws AccessControlException

Sets status for a match that has the given matchId internal ID.

Parameters:

matchId - the internal ID of the match of interest

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

Returns:

updated match

Throws:

AccessControlException - if user does not have at least view access to each patient in the match

setUserContacted

PatientMatch setUserContacted(Long matchId,
                              boolean isUserContacted)
                       throws AccessControlException

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

Parameters:

matchId - the internal ID of the match of interest

isUserContacted - boolean user-contacted status to set for matches

Returns:

updated match

Throws:

AccessControlException - if user does not have at least view access to each patient in the match

saveComment

PatientMatch saveComment(Long matchId,
                         String comment)
                  throws AccessControlException

Saves comment for a match that has the given matchId internal ID.

Parameters:

matchId - the internal ID of the match of interest

comment - comment text

Returns:

updated match

Throws:

AccessControlException - if user does not have at least view access to each patient in the match

addNote

PatientMatch addNote(Long matchId,
                     String note)
              throws AccessControlException

Saves note for a match that has the given matchId internal ID.

Parameters:

matchId - the internal ID of the match of interest

note - note text

Returns:

updated match

Throws:

AccessControlException - if user does not have at least view access to each patient in the match

getMatch

PatientMatch getMatch(Long matchId)

Returns a match that has the given matchId internal ID.

Parameters:

matchId - the internal ID of the match of interest

Returns:

PatientMatch match object