uk.ac.ed.epcc.webapp

Interface Setting<V>

Type Parameters:

V - type of Setting

All Superinterfaces:

java.lang.Comparable<Setting>, Targetted<V>, TypeConverter<V,java.lang.String>

All Known Subinterfaces:

PreferenceSetting<V>

All Known Implementing Classes:

AbstractSetting, EnumPreference, EnumSetting, Feature, Preference, StringPreference, StringSetting

public interface Setting<V>
extends java.lang.Comparable<Setting>, TypeConverter<V,java.lang.String>

A Setting is a configuration parameter with a fixed set of valid values and encapsulted in a model object (usually a singleton) This can either be a configuration parameter that changes the or a user preference of some sort. These can always be set as values in the config but user preferences may also be overidden by database settings in on a per-user basis. The Setting interface is primarily used by the user preference transition but this can also be used by an admin to change system parameters.

Method Summary

Modifier and Type	Method and Description
default int	compareTo(Setting o)
V	getCurrent(AppContext conn) get the current value of the setting
V	getDefault() get the default (compiled) value of the setting.
java.lang.String	getDescription() Descriptive text of the purpose/meaning of the setting.
ItemInput<java.lang.String,V>	getInput(AppContext conn) and Input to select the setting
java.lang.String	getName() Name of the setting.

Methods inherited from interface uk.ac.ed.epcc.webapp.model.data.convert.TypeConverter

find, getIndex

Methods inherited from interface uk.ac.ed.epcc.webapp.Targetted

getTarget

Method Detail

getName

java.lang.String getName()

Name of the setting. Other than a type-specific prefix this is also the name of the configuration parameter corresponding to the setting

Returns:

getDescription

java.lang.String getDescription()

Descriptive text of the purpose/meaning of the setting.

Returns:

getInput

ItemInput<java.lang.String,V> getInput(AppContext conn)

and Input to select the setting

Returns:

compareTo

default int compareTo(Setting o)

Specified by:

compareTo in interface java.lang.Comparable<Setting>

getDefault

V getDefault()

get the default (compiled) value of the setting.

Returns:

getCurrent

V getCurrent(AppContext conn)

get the current value of the setting

Parameters:

conn - AppContext

Returns: