org.phenotips.configuration.spi

Class UIXRecordElement

java.lang.Object

org.phenotips.configuration.spi.UIXRecordElement

All Implemented Interfaces:

RecordElement

public class UIXRecordElement
extends Object
implements RecordElement

An implementation for RecordElement which reads the configuration from an UIExtension xobject.

Since:

1.4

Version:

$Id: a4a465e9b025150290622c8c9ce8f020c4f6cd1d $

Constructor Summary

Constructors

Constructor and Description
UIXRecordElement(org.xwiki.uiextension.UIExtension extension, RecordSection section) Simple constructor, taking a UI extension and the parent record section as parameters.

Method Summary

Modifier and Type	Method and Description
boolean	containsPrivateIdentifiableInformation() Whether this element contains any private identifiable information (PII) or not.
RecordSection	getContainingSection() The parent section containing this element.
List<String>	getDisplayedFields() The list of fields displayed in the 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 record or not.
void	setEnabled(boolean enabled) Sets whether this element is going to be displayed in the record or not.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UIXRecordElement

public UIXRecordElement(org.xwiki.uiextension.UIExtension extension,
                        RecordSection section)

Simple constructor, taking a UI extension and the parent record section as parameters.

Parameters:

extension - the UI extension object defining this record element

section - the parent section containing this element

Throws:

IllegalArgumentException - if extension or section are null

Method Detail

getExtension

public org.xwiki.uiextension.UIExtension getExtension()

Description copied from interface: RecordElement

The extension defining this element.

Specified by:

getExtension in interface RecordElement

Returns:

a valid UIExtension object

getName

public String getName()

Description copied from interface: RecordElement

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

Specified by:

getName in interface RecordElement

Returns:

a user-friendly name for this element

isEnabled

public boolean isEnabled()

Description copied from interface: RecordElement

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

Specified by:

isEnabled in interface RecordElement

Returns:

true if this element must be displayed, false otherwise

containsPrivateIdentifiableInformation

public boolean containsPrivateIdentifiableInformation()

Description copied from interface: RecordElement

Whether this element contains any private identifiable information (PII) or not.

Specified by:

containsPrivateIdentifiableInformation in interface RecordElement

Returns:

true if this element contains PII, false otherwise

getDisplayedFields

public List<String> getDisplayedFields()

Description copied from interface: RecordElement

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

Specified by:

getDisplayedFields in interface RecordElement

Returns:

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

getContainingSection

public RecordSection getContainingSection()

Description copied from interface: RecordElement

The parent section containing this element.

Specified by:

getContainingSection in interface RecordElement

Returns:

a valid section

toString

public String toString()

Overrides:

toString in class Object

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: RecordElement

Sets whether this element is going to be displayed in the record or not. All changes are done in-memory for this object only, the configuration will remain unchanged.

Specified by:

setEnabled in interface RecordElement

Parameters:

enabled - true if this element should be displayed, false otherwise