Consent (PhenoTips - Consents - Java APIs 1.4-rc-3 API)

```
@Unstable
public interface Consent
```
Used for representing a single consent; for example in a patient record.

Since:

1.3M1

Version:

$Id: 2fd73f5c5714b9c9e027dd0bcb59563bec3a957d $

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`affectsAllFields()` A convenience method to determine that all or no fields are affected.
`boolean`	`affectsSomeFields()` A convenience method to determine that at least one field is affected (e.g.
`Consent`	`copy(ConsentStatus status)` Returns a copy of this consent with the given status set instead of the current status.
`List<String>`	`getDataFields()` The list of (UIX) fields only available if consent is granted.
`String`	`getDescription()` An optional (potentially long) description which is supposed to be displayed under a consent, possibly with links to external documents such as consent form(s).
`List<String>`	`getFields()` The list of (patient form) fields only available if consent is granted.
`String`	`getId()` Internally, consents are referred by their identifiers.
`String`	`getLabel()` The users never sees the ids of the consents, they only see labels (aka titles).
`ConsentStatus`	`getStatus()` Could be notLoaded/Yes/No.
`boolean`	`isGranted()` A convenience method to check if Consent status is Yes.
`boolean`	`isRequired()` Some consents are required to for any interaction with a patient record data (viewing, modifying, etc).
`void`	`setStatus(ConsentStatus status)` The status should be dynamically changeable.
`org.json.JSONObject`	`toJSON()` Consents should be convertible into a JSON format.

- Method Detail
  - getId
```
String getId()
```
    Internally, consents are referred by their identifiers.
    
    Returns:
    
    the id of this consent
  - getLabel
```
String getLabel()
```
    The users never sees the ids of the consents, they only see labels (aka titles).
    
    Returns:
    
    the description of this consent
  - getDescription
```
String getDescription()
```
    An optional (potentially long) description which is supposed to be displayed under a consent, possibly with links to external documents such as consent form(s).
    
    Returns:
    
    the long description of this consent
  - getStatus
```
ConsentStatus getStatus()
```
    Could be notLoaded/Yes/No. The consent configurations (description, id) will be coming from the database, and should not be reloaded often. There should then be a cache of all the consents in the system with a status of notLoaded.
    
    Returns:
    
    ConsentStatus which should generally be Yes or No, but could be notLoaded
  - isGranted
```
boolean isGranted()
```
    A convenience method to check if Consent status is Yes.
    
    Returns:
    
    true iff getStatus() == Yes, false otherwise
  - setStatus
```
void setStatus(ConsentStatus status)
```
    The status should be dynamically changeable.
    
    Parameters:
    
    status - the new status
  - isRequired
```
boolean isRequired()
```
    Some consents are required to for any interaction with a patient record data (viewing, modifying, etc).
    
    Returns:
    
    true if required, false otherwise
  - getDataFields
```
List<String> getDataFields()
```
    The list of (UIX) fields only available if consent is granted. If a field is affected by more than one consent, all of the consents have to be granted in order to enable the field.
    
    Returns:
    
    A list of values present in the fields parameter of the UI extensions. If all fields are affected an empty list is returned. If no fields are affected null is returned.
  - getFields
```
List<String> getFields()
```
    The list of (patient form) fields only available if consent is granted. If a field is affected by more than one consent, all of the consents have to be granted in order to enable the field.
    
    Returns:
    
    A list of field IDs of the affected fields. If all fields are affected an empty list is returned. If no fields are affected null is returned.
  - affectsAllFields
```
boolean affectsAllFields()
```
    A convenience method to determine that all or no fields are affected.
    
    Returns:
    
    true if all fields are affected, false otherwise
  - affectsSomeFields
```
boolean affectsSomeFields()
```
    A convenience method to determine that at least one field is affected (e.g. a consent may be requred for something other than fields).
    
    Returns:
    
    true if at least one fields is affected.
  - toJSON
```
org.json.JSONObject toJSON()
```
    Consents should be convertible into a JSON format.
    
    Returns:
    
    a JSON object representing this consent
  - copy
```
Consent copy(ConsentStatus status)
```
    Returns a copy of this consent with the given status set instead of the current status.
    
    Parameters:
    
    status - the new status
    
    Returns:
    
    a new consent object identical to current except that the status is set to the given one.

Interface Consent

Method Summary

Method Detail

getId

getLabel

getDescription

getStatus

isGranted

setStatus

isRequired

getDataFields

getFields

affectsAllFields

affectsSomeFields

toJSON

copy