blackboard.base
Class BbLabeledEnum

java.lang.Object
  blackboard.base.BbEnum
      blackboard.base.BbLabeledEnum

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

public abstract class BbLabeledEnum
extends BbEnum
implements java.lang.Comparable

Base enumeration class for enumerations that are used to supply UI-visible labels. Performs a lookup using the BbResourceBundle with the provided key.

Note: This class is designed to localize Assessment and Gradebook apis that have hardcoded english strings into existing APIs.

Since:

Bb 6.2

Version:

$Revision: #1 $ $Date: 2005/06/27 $

See Also:

Serialized Form

Constructor Summary

protected

BbLabeledEnum(java.lang.String enumFieldName, java.lang.String displayKey) Constructor

Method Summary

protected abstract java.lang.String	getBundleName() assessmentEnum will extend getBundle to return "assessment", then all assessment enums will extend AssessmentEnum
java.lang.String	getDisplayName()

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

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

BbLabeledEnum

protected BbLabeledEnum(java.lang.String enumFieldName,
                        java.lang.String displayKey)

Constructor

Method Detail

getBundleName

protected abstract java.lang.String getBundleName()

assessmentEnum will extend getBundle to return "assessment", then all assessment enums will extend AssessmentEnum

getDisplayName

public java.lang.String getDisplayName()