org.phenotips.configuration.script

Class RecordConfigurationManagerScriptService

java.lang.Object

org.phenotips.configuration.script.RecordConfigurationManagerScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Unstable
 @Component
 @Named(value="recordConfiguration")
 @Singleton
public class RecordConfigurationManagerScriptService
extends Object
implements org.xwiki.script.service.ScriptService

Provides access to RecordConfiguration record configurations.

Since:

1.0M9

Version:

$Id: f4775ee519a0052e68728501c2bd16030c8c3eb4 $

Constructor Summary

Constructors

Constructor and Description
RecordConfigurationManagerScriptService()

Method Summary

Modifier and Type	Method and Description
RecordConfiguration	getActiveConfiguration() Deprecated. since 1.4, use getConfiguration(String) instead
RecordConfiguration	getConfiguration(String recordType) Retrieves the RecordConfiguration active for the current user on a specific record type.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordConfigurationManagerScriptService

public RecordConfigurationManagerScriptService()

Method Detail

getActiveConfiguration

@Deprecated
public RecordConfiguration getActiveConfiguration()

Deprecated. since 1.4, use getConfiguration(String) instead

Retrieves the record configuration for patient records active for the current user.

Returns:

a valid configuration, either the global one or one configured, for example in one of the user's groups

getConfiguration

public RecordConfiguration getConfiguration(String recordType)

Retrieves the RecordConfiguration active for the current user on a specific record type.

Parameters:

recordType - an identifier for the type of record whose configuration is requested, such as patient or family

Returns:

a valid configuration, may be empty if no sections can be displayed

Since:

1.4