org.jasig.schedassist.model
Enum Preferences

java.lang.Object
  java.lang.Enum<Preferences>
      org.jasig.schedassist.model.Preferences

All Implemented Interfaces:

Serializable, Comparable<Preferences>

public enum Preferences
extends Enum<Preferences>

Enum to store the displayName and key for the different Schedule Owner preferences stored in the Scheduling Assistant system.

Version:

$Id: Preferences.java 2983 2011-01-26 21:52:38Z npblair $

Author:

Nicholas Blair, nblair@doit.wisc.edu

Enum Constant Summary

ADVISOR_SHARE_WITH_STUDENTS

DEFAULT_VISITOR_LIMIT

DURATIONS

INSTRUCTOR_SHARE_WITH_STUDENTS

LOCATION

MEETING_LIMIT

MEETING_PREFIX

NOTEBOARD

REFLECT_SCHEDULE

REMINDERS

VISIBLE_WINDOW

Method Summary

static Preferences	fromDisplayName(String displayName)
static Preferences	fromKey(String key)
static Map<Preferences,String>	getDefaultPreferences() Returns a Map containing all Preferences as keys mapped to their default values (as Strings).
String	getDefaultValue()
String	getDisplayName()
String	getKey()
static Preferences	valueOf(String name) Returns the enum constant of this type with the specified name.
static Preferences[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOTEBOARD

public static final Preferences NOTEBOARD

LOCATION

public static final Preferences LOCATION

MEETING_PREFIX

public static final Preferences MEETING_PREFIX

DURATIONS

public static final Preferences DURATIONS

VISIBLE_WINDOW

public static final Preferences VISIBLE_WINDOW

ADVISOR_SHARE_WITH_STUDENTS

public static final Preferences ADVISOR_SHARE_WITH_STUDENTS

DEFAULT_VISITOR_LIMIT

public static final Preferences DEFAULT_VISITOR_LIMIT

MEETING_LIMIT

public static final Preferences MEETING_LIMIT

REFLECT_SCHEDULE

public static final Preferences REFLECT_SCHEDULE

REMINDERS

public static final Preferences REMINDERS

INSTRUCTOR_SHARE_WITH_STUDENTS

public static final Preferences INSTRUCTOR_SHARE_WITH_STUDENTS

Method Detail

values

public static Preferences[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Preferences c : Preferences.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Preferences valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getDisplayName

public String getDisplayName()

Returns:

the displayName

getKey

public String getKey()

Returns:

the key

getDefaultValue

public String getDefaultValue()

Returns:

the defaultValue

fromKey

public static Preferences fromKey(String key)

Parameters:

key -

Returns:

null if no Preferences has a matching key

fromDisplayName

public static Preferences fromDisplayName(String displayName)

Parameters:

displayName -

Returns:

null if no Preferences has a matching displayName

getDefaultPreferences

public static Map<Preferences,String> getDefaultPreferences()

Returns a Map containing all Preferences as keys mapped to their default values (as Strings).

Returns:

a Map of Preferences as keys and their default values