blackboard.data.gradebook
Class ReportingPeriod

java.lang.Object
  |
  +--blackboard.base.BbEnum
        |
        +--blackboard.data.gradebook.ReportingPeriod

All Implemented Interfaces:

java.lang.Comparable

public class ReportingPeriod

extends BbEnum

The ReportingPeriod class provides a reporting period of a course.

Since:

Bb 5.5

Version:

$Revision: 2 $ $Date: 6/23/03 1:16p $

Field Summary

static ReportingPeriod	ALL
static ReportingPeriod	DEFAULT
static ReportingPeriod	FINAL
static ReportingPeriod	MIDTERM
static ReportingPeriod	UNKNOWN

Method Summary

static ReportingPeriod	fromExternalString(java.lang.String externalString) Returns the ReportingPeriod element specified by the externalString.
static java.lang.String[]	toCategoryTitles(java.lang.String fieldName)

Methods inherited from class blackboard.base.BbEnum

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

Methods inherited from class java.lang.Object

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

Field Detail

ALL

public static final ReportingPeriod ALL

MIDTERM

public static final ReportingPeriod MIDTERM

FINAL

public static final ReportingPeriod FINAL

UNKNOWN

public static final ReportingPeriod UNKNOWN

DEFAULT

public static final ReportingPeriod DEFAULT

Method Detail

toCategoryTitles

public static java.lang.String[] toCategoryTitles(java.lang.String fieldName)

fromExternalString

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

Returns the ReportingPeriod element specified by the externalString.

Throws:

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