org.phenotips.configuration.spi

Interface RecordConfigurationModule

@Unstable(value="New API introduced in 1.4")
 @Role
public interface RecordConfigurationModule

Modular record configuration service which provides or alters the record configuration according to a specific purpose. This can be implemented by different components, each one with a different priority. When a specific record configuration is requested, each of the available implementations will be queried by the RecordConfigurationManager in ascending order of their priority, starting with an empty configuration that can be altered by each module, and the final record configuration obtained after this process is considered the active configuration to be displayed.

Since:

1.4

Version:

$Id: 9d5f8913b304c1af4dbd7fa4136d1023fa0d3b0e $

Method Summary

Modifier and Type	Method and Description
int	getPriority() The priority of this implementation.
RecordConfiguration	process(RecordConfiguration config) Configures how the record appears.
boolean	supportsRecordType(String recordType) Indicates whether this configuration modules supports a specific type of record.

Method Detail

process

RecordConfiguration process(RecordConfiguration config)

Configures how the record appears.

Parameters:

config - the previous configuration

Returns:

an updated configuration

getPriority

int getPriority()

The priority of this implementation. Implementations with a lower priority will be invoked before implementations with a higher priority. The base implementation has a priority of 0, and returns the global configuration. It is recommended that the returned values be in the [0..100] range.

Returns:

a positive number

supportsRecordType

boolean supportsRecordType(String recordType)

Indicates whether this configuration modules supports a specific type of record.

Parameters:

recordType - the string representing the type of record

Returns:

true iff this module supports the specified record type, false otherwise