uk.ac.ed.epcc.webapp.preferences

Class Preference

java.lang.Object

uk.ac.ed.epcc.webapp.AbstractSetting<java.lang.Boolean>

uk.ac.ed.epcc.webapp.Feature

uk.ac.ed.epcc.webapp.preferences.Preference

All Implemented Interfaces:

java.lang.Comparable<Setting>, TypeConverter<java.lang.Boolean,java.lang.String>, PreferenceSetting<java.lang.Boolean>, Setting<java.lang.Boolean>, Targetted<java.lang.Boolean>

public class Preference
extends Feature
implements PreferenceSetting<java.lang.Boolean>

A Preference is a Feature that only affects presentation logic so a user is allowed to override the system-wide value with their own setting. This can be dynamically degraded to a non-settable Feature busing the boolean config parameter service.feature.name.settable

Constructor Summary

Constructors

Constructor and Description
Preference(java.lang.String name, boolean def, java.lang.String description)
Preference(java.lang.String name, boolean def, java.lang.String description, java.lang.String... required_roles)

Method Summary

Modifier and Type	Method and Description
boolean	canUserSet(AppContext conn)
boolean	canView(SessionService<?> sess) Does the current user have permissions to set/view this preference.
static boolean	checkDynamicPreference(AppContext conn, java.lang.String name, boolean def, java.lang.String desc, java.lang.String... roles) checks a Preference that is only defined by name (ie the name is generated dynamically)
void	clearPreference(AppContext conn)
java.lang.Boolean	defaultSetting(AppContext conn)
boolean	hasPreference(AppContext conn)
boolean	isEnabled(AppContext conn)
void	setPreference(AppContext conn, java.lang.Boolean value)

Methods inherited from class uk.ac.ed.epcc.webapp.Feature

checkDynamicFeature, checkFeature, find, getConfigValue, getCurrent, getIndex, getInput, getTag, getTarget, getText, isDef, isEnabled, setTempFeature

Methods inherited from class uk.ac.ed.epcc.webapp.AbstractSetting

equals, findFeatureByName, getDefault, getDescription, getFeatureTable, getKnownFeatures, getName, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

compareTo, getCurrent, getDefault, getDescription, getInput, getName

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

Constructor Detail

Preference

public Preference(java.lang.String name,
                  boolean def,
                  java.lang.String description)

Parameters:

name -

def -

description -

Preference

public Preference(java.lang.String name,
                  boolean def,
                  java.lang.String description,
                  java.lang.String... required_roles)

Method Detail

isEnabled

public boolean isEnabled(AppContext conn)

Overrides:

isEnabled in class Feature

canUserSet

public boolean canUserSet(AppContext conn)

defaultSetting

public java.lang.Boolean defaultSetting(AppContext conn)

Specified by:

defaultSetting in interface PreferenceSetting<java.lang.Boolean>

hasPreference

public boolean hasPreference(AppContext conn)

Specified by:

hasPreference in interface PreferenceSetting<java.lang.Boolean>

clearPreference

public void clearPreference(AppContext conn)
                     throws DataFault

Specified by:

clearPreference in interface PreferenceSetting<java.lang.Boolean>

Throws:

DataFault

setPreference

public void setPreference(AppContext conn,
                          java.lang.Boolean value)

Specified by:

setPreference in interface PreferenceSetting<java.lang.Boolean>

canView

public boolean canView(SessionService<?> sess)

Does the current user have permissions to set/view this preference.

Specified by:

canView in interface PreferenceSetting<java.lang.Boolean>

Parameters:

sess -

Returns:

checkDynamicPreference

public static boolean checkDynamicPreference(AppContext conn,
                                             java.lang.String name,
                                             boolean def,
                                             java.lang.String desc,
                                             java.lang.String... roles)

checks a Preference that is only defined by name (ie the name is generated dynamically)

Parameters:

conn -

name -

Returns: