blackboard.data.calendar
Class CalendarEntry.Type

java.lang.Object
  blackboard.base.BbEnum
      blackboard.data.calendar.CalendarEntry.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Enclosing class:

CalendarEntry

public static final class CalendarEntry.Type
extends BbEnum

Enumeration of the different types of calendar events supported by the Blackboard Calendar tool.

See Also:

Serialized Form

Field Summary

static CalendarEntry.Type	COURSE The entry is associated with a course, and is viewable from the course's (or organization's) calendar tool.
static CalendarEntry.Type	DEFAULT The default entry is PERSONAL.
static CalendarEntry.Type	INSTITUTION The entry is system-wide and viewable from the system-level calendar tool.
static CalendarEntry.Type	PERSONAL The entry is associated with a user and viewable from the system-level calendar tool, which also aggregates system entries and course entries for the current user.

Method Summary

static CalendarEntry.Type	fromExternalString(java.lang.String externalString) Returns the CalendarEntry.Type element specified by the externalString
static CalendarEntry.Type[]	getValues() Returns an array of all of the elements in this enumeration.

Methods inherited from class blackboard.base.BbEnum

compareTo, defineAlias, defineDefault, fromExternalString, fromFieldName, fromFieldName, getDefaultElement, getValues, isDefault, readResolve, toExternalString, toFieldName, toString

Methods inherited from class java.lang.Object

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

Field Detail

COURSE

public static final CalendarEntry.Type COURSE

The entry is associated with a course, and is viewable from the course's (or organization's) calendar tool.

INSTITUTION

public static final CalendarEntry.Type INSTITUTION

The entry is system-wide and viewable from the system-level calendar tool.

PERSONAL

public static final CalendarEntry.Type PERSONAL

The entry is associated with a user and viewable from the system-level calendar tool, which also aggregates system entries and course entries for the current user.

DEFAULT

public static final CalendarEntry.Type DEFAULT

The default entry is PERSONAL.

Method Detail

getValues

public static CalendarEntry.Type[] getValues()

Returns an array of all of the elements in this enumeration.

fromExternalString

public static CalendarEntry.Type fromExternalString(java.lang.String externalString)
                                             throws java.lang.IllegalArgumentException

Returns the CalendarEntry.Type element specified by the externalString

Parameters:

externalString - String used to return the correct CalendarEntry.Type

Returns:

The CalendarEntry.Type equivalent to the String parameter passed

Throws:

java.lang.IllegalArgumentException - if the given string is not an external representation of one of the elements of this enumeration class