org.phenotips.matchingnotification.finder

Interface MatchFinder

@Role
public interface MatchFinder

Version:

$Id: 896c54dd061b912cede9fc9587e8286caf2d5e6f $

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.
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