org.phenotips.matchingnotification.finder

Interface MatchFinderManager

@Role
public interface MatchFinderManager

Version:

$Id: ba02ca95e3250562d90515ca7dde73d09a63d3e1 $

Method Summary

Modifier and Type	Method and Description
void	findMatchesForAllPatients(Set<String> serverIds, boolean onlyCheckPatientsUpdatedAfterLastRun) Finds matches for all local patients on the selected servers.
javax.ws.rs.core.Response	findMatchesForPatient(org.phenotips.data.Patient patient, String serverId) Finds matches for a local patient on the selected server.
org.json.JSONObject	getLastMatchUpdateStatus(String patientId) Returns a JSON object containing last matches update details for a provided patientId patient for all servers (local matches or MME matches).

Method Detail

findMatchesForAllPatients

void findMatchesForAllPatients(Set<String> serverIds,
                               boolean onlyCheckPatientsUpdatedAfterLastRun)

Finds matches for all local patients on the selected servers. For each patient each matcher used will check if the patient can be matched using the matcher (e.g. patient is "matchable", or a "matchable" consent is granted, etc.). All matches that are found will be stored in the matching notification table.

Parameters:

serverIds - a list of servers to be used for matches search indicated by their ids.

onlyCheckPatientsUpdatedAfterLastRun - if true, the selected matcher(s) will only re-check patients which have been modified after the last time that matcher was run

findMatchesForPatient

javax.ws.rs.core.Response findMatchesForPatient(org.phenotips.data.Patient patient,
                                                String serverId)

Finds matches for a local patient on the selected server. All matches that are found will be stored in the matching notification table.

Parameters:

patient - local reference patient

serverId - server to be used for matches search

Returns:

a response containing a success message or an error code if unsuccessful

getLastMatchUpdateStatus

org.json.JSONObject getLastMatchUpdateStatus(String patientId)

Returns a JSON object containing last matches update details for a provided patientId patient for all servers (local matches or MME matches).

Parameters:

patientId - local patient ID

Returns:

JSON containing, for each configured server(including local), dates of the last match update request (if any) and last successful match update request (if any, can be the same as the last request), as well as the last error iff the last request generated an error, in the following format: { server_id: { "lastSuccessfulMatchUpdateDate": date (or null if there were no successful requests), "lastMatchUpdateDate": date (or null if there were no match requests to this server), "lastMatchUpdateErrorCode": HTTP error code (if the last macth update failed, optional), "lastMatchUpdateError": a JSON with error details (if the was an error, optional) }, ... }