org.phenotips.configuration

Interface RecordConfiguration

@Unstable
public interface RecordConfiguration

Exposes the current configuration related to the patient record.

Since:

1.0M9

Version:

$Id: 71773f4b04b344566fa5cf6144de92f9f618229b $

Field Summary

Fields

Modifier and Type	Field and Description
static org.xwiki.model.reference.EntityReference	CUSTOM_PREFERENCES_CLASS The XClass used for storing group- and user-specific configurations.
static org.xwiki.model.reference.EntityReference	GLOBAL_PREFERENCES_CLASS The XClass used for storing the global configuration.

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getAllFieldNames() The list of possible fields defined in the application.
List<RecordSection>	getAllSections() The list of available sections, enabled or disabled, that can be displayed in the patient record.
String	getDateOfBirthFormat() The format of the date of birth, in the standard Java date format.
List<String>	getEnabledFieldNames() The list of fields displayed in the patient record.
List<String>	getEnabledNonIdentifiableFieldNames() The list of non-identifiable fields displayed in the patient record (i.e.
List<RecordSection>	getEnabledSections() The list of sections enabled in the patient record.
String	getISODateFormat() The date format compliant with the ISO 8601 standard, in the Java date format.
org.xwiki.model.reference.DocumentReference	getPhenotypeMapping() The custom predefined phenotypes displayed in the "Clinical Symptoms" section are configured in a document, and this type of configuration is called a "Phenotype Mapping".

Field Detail

GLOBAL_PREFERENCES_CLASS

static final org.xwiki.model.reference.EntityReference GLOBAL_PREFERENCES_CLASS

The XClass used for storing the global configuration.

CUSTOM_PREFERENCES_CLASS

static final org.xwiki.model.reference.EntityReference CUSTOM_PREFERENCES_CLASS

The XClass used for storing group- and user-specific configurations.

Method Detail

getEnabledSections

List<RecordSection> getEnabledSections()

The list of sections enabled in the patient record.

Returns:

an unmodifiable ordered list of sections, empty if none are enabled or the configuration is missing

getAllSections

List<RecordSection> getAllSections()

The list of available sections, enabled or disabled, that can be displayed in the patient record.

Returns:

an unmodifiable ordered list of sections, or an empty list if none are defined

getEnabledFieldNames

List<String> getEnabledFieldNames()

The list of fields displayed in the patient record.

Returns:

an unmodifiable ordered list of field names, empty if none are enabled or the configuration is missing

getEnabledNonIdentifiableFieldNames

List<String> getEnabledNonIdentifiableFieldNames()

The list of non-identifiable fields displayed in the patient record (i.e. fields which contain no personal information which can be tracked to a particular patient)

Returns:

an unmodifiable ordered list of field names, empty if no non-identifiable fields are enabled or the configuration is missing

getAllFieldNames

List<String> getAllFieldNames()

The list of possible fields defined in the application. This doesn't include metadata stored in separate entities, such as measurements, relatives, additional files, etc.

Returns:

an unmodifiable ordered list of field names, empty if none are available or the configuration is missing

getPhenotypeMapping

@Unstable
org.xwiki.model.reference.DocumentReference getPhenotypeMapping()

The custom predefined phenotypes displayed in the "Clinical Symptoms" section are configured in a document, and this type of configuration is called a "Phenotype Mapping". Multiple such mappings can exist in a PhenoTips instance, and one of these mappings can be selected as the preferred mapping to be used globally or for each group. Warning! The return type of this method is likely to change once a more specific class for representing mappings will be implemented.

Returns:

the selected phenotype mapping, as a reference to the document where the mapping is defined

getISODateFormat

String getISODateFormat()

The date format compliant with the ISO 8601 standard, in the Java date format.

Returns:

the configured date format

getDateOfBirthFormat

String getDateOfBirthFormat()

The format of the date of birth, in the standard Java date format.

Returns:

the configured date format