org.phenotips.data.push

Interface PushServerSendPatientResponse

All Superinterfaces:

PushServerGetPatientIDResponse, PushServerResponse

@Unstable
@Role
public interface PushServerSendPatientResponse
extends PushServerGetPatientIDResponse

API that allows pushing patient data to a remote PhenoTips instance.

Since:

1.0M11

Version:

$Id: 4ccd5fe7d510577305255946cf7954928ff47549 $

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isActionFailed_GUIDAccessDenied()
boolean	isActionFailed_incorrectGroup()
boolean	isActionFailed_IncorrectGUID()
boolean	isActionFailed_MissingConsent()
boolean	isActionFailed_UpdatesDisabled()

Methods inherited from interface org.phenotips.data.push.PushServerGetPatientIDResponse

getRemotePatientGUID, getRemotePatientID, getRemotePatientURL

Methods inherited from interface org.phenotips.data.push.PushServerResponse

isActionFailed_isUnknownAction, isActionFailed_knownReason, isActionFailed, isClientDoesNotAcceptServerProtocolVersion, isLoginFailed_IncorrectCredentials, isLoginFailed_knownReason, isLoginFailed_TokensNotSuported, isLoginFailed_UnauthorizedServer, isLoginFailed_UserTokenExpired, isLoginFailed, isServerDoesNotAcceptClientProtocolVersion, isSuccessful

Method Detail

isActionFailed_incorrectGroup

boolean isActionFailed_incorrectGroup()

Returns:

true iff the group name provided in the push request is either not a valid group name or corresponds to a group that the user provided is not a member of.

isActionFailed_UpdatesDisabled

boolean isActionFailed_UpdatesDisabled()

Returns:

true iff GUID was provided in the push request and updating existing patients is disabled on the server.

isActionFailed_IncorrectGUID

boolean isActionFailed_IncorrectGUID()

Returns:

true iff GUID provided in the push request does not correspond to an existing PhenoTips Patient object on the remote server.

isActionFailed_GUIDAccessDenied

boolean isActionFailed_GUIDAccessDenied()

Returns:

true iff GUID was provided in the push request and the user specified in the request does not have permissions to update the corresponding document on the remote server.

isActionFailed_MissingConsent

boolean isActionFailed_MissingConsent()

Returns:

true iff at least one consent that is required to have a patient record on the remote server is missing. A missing consent is a consent that was not granted by the user on the local instance during push.