org.phenotips.configuration

Interface RecordConfiguration

@Unstable
public interface RecordConfiguration

Exposes the configuration for displaying records.

Since:

1.0M9

Version:

$Id: 023b53211d0d6b64b5bda3f1c3d7cf0141e15e9a $

Field Summary

Fields

Modifier and Type	Field and Description
static org.xwiki.model.reference.EntityReference	CUSTOM_PREFERENCES_CLASS Deprecated. since 1.4, this is specific to studies and has been moved in a different module
static org.xwiki.model.reference.EntityReference	GLOBAL_PREFERENCES_CLASS The XClass used for storing the global configuration.

Method Summary

Modifier and Type	Method and Description
List<String>	getAllFieldNames() The list of available fields, enabled or disabled, that can be displayed in this type of record.
List<RecordSection>	getAllSections() The list of available sections, enabled or disabled, that can be displayed in this type of record.
String	getDateOfBirthFormat() The format to use for entering and displaying the date of birth and other dates.
List<String>	getEnabledFieldNames() The list of fields enabled for this record type.
List<String>	getEnabledNonIdentifiableFieldNames() Deprecated. since 1.4, this functionality has moved in the Consents module
List<RecordSection>	getEnabledSections() The list of sections enabled for this record type.
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".
void	setDateOfBirthFormat(String format) Update the format of the date of birth.
void	setPhenotypeMapping(org.xwiki.model.reference.DocumentReference mapping) Update the preferred phenotype mapping.
void	setSections(List<RecordSection> sections) Update the list of available section.

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

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

Deprecated. since 1.4, this is specific to studies and has been moved in a different module

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

Method Detail

getEnabledSections

List<RecordSection> getEnabledSections()

The list of sections enabled for this record type.

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 this type of record.

Returns:

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

setSections

void setSections(List<RecordSection> sections)

Update the list of available section. All changes are done in-memory for this object only, the configuration will remain unchanged.

Parameters:

sections - a list of sections, may be empty

Since:

1.4

See Also:

getAllSections()

getEnabledFieldNames

List<String> getEnabledFieldNames()

The list of fields enabled for this record type.

Returns:

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

getEnabledNonIdentifiableFieldNames

@Deprecated
List<String> getEnabledNonIdentifiableFieldNames()

Deprecated. since 1.4, this functionality has moved in the Consents module

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 available fields, enabled or disabled, that can be displayed in this type of record.

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

setPhenotypeMapping

@Unstable
void setPhenotypeMapping(org.xwiki.model.reference.DocumentReference mapping)

Update the preferred phenotype mapping. All changes are done in-memory for this object only, the configuration will remain unchanged.

Parameters:

mapping - a reference to a document containing a phenotype mapping definition

Since:

1.4

See Also:

getPhenotypeMapping()

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 to use for entering and displaying the date of birth and other dates. For privacy reasons, certain PhenoTips instances may only record the year and month, or even just the year, so formats like yyyy, MM/yyyy, or MMMM yyyy are supported. This also allows switching between different formats such as yyyy-MM-dd, dd/MM/yyyy, or MM/dd/yyyy.

Returns:

the configured date format, in the Java date format

setDateOfBirthFormat

void setDateOfBirthFormat(String format)

Update the format of the date of birth. All changes are done in-memory for this object only, the configuration will remain unchanged.

Parameters:

format - the new date format, in the Java date format

Since:

1.4

See Also:

getDateOfBirthFormat()