org.phenotips.matchingnotification.finder

Interface MatchFinder

@Role
public interface MatchFinder

Version:

$Id: e6240004d43419fe47001fbbe278ddb16de43984 $

Method Summary

Modifier and Type	Method and Description
int	findMatches(List<String> patientIds, Set<String> serverIds, boolean onlyUpdatedAfterLastRun) Finds matches for all patients.
javax.ws.rs.core.Response	findMatches(org.phenotips.data.Patient patient, String serverId) Finds matches for a given patient.
org.json.JSONObject	getLastUpdatedDateForServerForPatient(String patientId, String serverId) Finds last matches update status for a provided patientId patient for the selected server.
int	getPriority()
Set<String>	getSupportedServerIdList()

Method Detail

getPriority

int getPriority()

Returns:

a positive number representing the priority of current match finder

getSupportedServerIdList

Set<String> getSupportedServerIdList()

Returns:

list of supported servers for matches search

findMatches

int findMatches(List<String> patientIds,
                Set<String> serverIds,
                boolean onlyUpdatedAfterLastRun)

Finds matches for all patients.

Parameters:

patientIds - List of local patients IDs

serverIds - a list of servers to be used for matches search indicated by their ids. Servers which are not supported by the given matcher will be silently ignored.

onlyUpdatedAfterLastRun - if true, only considers patients updated after the last time matcher was run

Returns:

number of matches found

findMatches

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

Finds matches for a given patient.

Parameters:

patient - local reference patient

serverId - the remote or local server to be queried for matching patients

Returns:

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

getLastUpdatedDateForServerForPatient

org.json.JSONObject getLastUpdatedDateForServerForPatient(String patientId,
                                                          String serverId)

Finds last matches update status for a provided patientId patient for the selected server.

Parameters:

patientId - local patient ID

serverId - the remote or local server

Returns:

JSON containing 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: { "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) }