org.phenotips.configuration

Interface RecordElement

@Unstable
public interface RecordElement

A single field or a small subset of related fields displayed in a RecordSection section.

Since:

1.0M9

Version:

$Id: 107d035f040a8eb9993ab42df2048a98be3fb4c6 $

Method Summary

Methods

Modifier and Type	Method and Description
boolean	containsPrivateIdentifiableInformation() Whether this element contains any private indentifiable information (PII) about the patient or not.
RecordSection	getContainingSection() The parent section containing this element.
List<String>	getDisplayedFields() The list of fields displayed in the patient record by this element.
org.xwiki.uiextension.UIExtension	getExtension() The extension defining this element.
String	getName() The name of this element, displayed in the form designer.
boolean	isEnabled() Whether this element is going to be displayed in the patient record or not.

Method Detail

getExtension

org.xwiki.uiextension.UIExtension getExtension()

The extension defining this element.

Returns:

a valid UIExtension object

getName

String getName()

The name of this element, displayed in the form designer.

Returns:

a user-friendly name for this element

isEnabled

boolean isEnabled()

Whether this element is going to be displayed in the patient record or not.

Returns:

true if this element must be displayed, false otherwise

containsPrivateIdentifiableInformation

boolean containsPrivateIdentifiableInformation()

Whether this element contains any private indentifiable information (PII) about the patient or not.

Returns:

true if this element contains PII, false otherwise

getDisplayedFields

List<String> getDisplayedFields()

The list of fields displayed in the patient record by this element.

Returns:

an unmodifiable ordered list of field names, empty if this element doesn't display patient fields

getContainingSection

RecordSection getContainingSection()

The parent section containing this element.

Returns:

a valid section