org.phenotips.consents.script

Class ConsentManagerScriptService

java.lang.Object

org.phenotips.consents.script.ConsentManagerScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Unstable
 @Component
 @Named(value="patientconsents")
 @Singleton
public class ConsentManagerScriptService
extends Object
implements org.xwiki.script.service.ScriptService

API that provides access to patient consents.

Since:

1.3M1

Version:

$Id: 591a96d233c95e00c0bd7ddc035441b82688da95 $

Constructor Summary

Constructors

Constructor and Description
ConsentManagerScriptService()

Method Summary

Modifier and Type	Method and Description
org.json.JSONArray	getAllConsentsForPatient(String patientId) Returns the list of all consents configured in the system, with "granted"/"not granted" status for the given patient for each consent.
boolean	hasConsent(String patientId, String consentId) Checks if a specific consent is given for the patient record.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConsentManagerScriptService

public ConsentManagerScriptService()

Method Detail

hasConsent

public boolean hasConsent(String patientId,
                          String consentId)

Checks if a specific consent is given for the patient record. If consentId is not configured in the system returns false regardless of patient consent status.

Parameters:

patientId - record in which to test consent

consentId - of consent which is to be checked

Returns:

true if the consent was granted for the patient, otherwise false

getAllConsentsForPatient

public org.json.JSONArray getAllConsentsForPatient(String patientId)

Returns the list of all consents configured in the system, with "granted"/"not granted" status for the given patient for each consent.

Parameters:

patientId - record on which consents are granted (or not granted)

Returns:

All the consents configured in the system with granted (for the patient) status set for each. Returns null if patientId is not a valid id.