org.phenotips.configuration

Interface RecordSection

@Unstable
public interface RecordSection

Represents a section that can be displayed in the patient record.

Since:

1.0M9

Version:

$Id: d195bbddfd427ebd8965edb1d4cef64c5adb875c $

Method Summary

Methods

Modifier and Type	Method and Description
List<RecordElement>	getAllElements() The list of elements configured in this section, whether they are enabled or not.
List<RecordElement>	getEnabledElements() The list of elements displayed in the patient record by this section.
org.xwiki.uiextension.UIExtension	getExtension() The extension defining this section.
String	getName() The name of this section, displayed in the patient record and in the form designer.
boolean	isEnabled() Whether this section and its elements are going to be displayed in the patient record or not.
boolean	isExpandedByDefault() Whether this section should be expanded and fully visible in edit mode by default.

Method Detail

getExtension

org.xwiki.uiextension.UIExtension getExtension()

The extension defining this section.

Returns:

a valid UIExtension object

getName

String getName()

The name of this section, displayed in the patient record and in the form designer.

Returns:

a user-friendly title for this section

isEnabled

boolean isEnabled()

Whether this section and its elements are going to be displayed in the patient record or not.

Returns:

true if this section must be displayed, false otherwise

isExpandedByDefault

boolean isExpandedByDefault()

Whether this section should be expanded and fully visible in edit mode by default.

Returns:

true if this section must be expanded, false otherwis

getAllElements

List<RecordElement> getAllElements()

The list of elements configured in this section, whether they are enabled or not.

Returns:

an unmodifiable ordered list of elements, empty if this section doesn't have any elements

getEnabledElements

List<RecordElement> getEnabledElements()

The list of elements displayed in the patient record by this section.

Returns:

an unmodifiable ordered list of enabled elements, empty if none are configured or enabled