blackboard.data.content
Class Link.ReferredToType

java.lang.Object
  |
  +--blackboard.base.BbEnum
        |
        +--blackboard.data.content.Link.ReferredToType

All Implemented Interfaces:

java.lang.Comparable

Enclosing class:

Link

public static final class Link.ReferredToType

extends BbEnum

Field Summary

static Link.ReferredToType	CONTENT
static Link.ReferredToType	COURSE_ASSESSMENT
static Link.ReferredToType	COURSE_TOC
static Link.ReferredToType	DEFAULT
static Link.ReferredToType	FORUM
static Link.ReferredToType	TOOL

Method Summary

static Link.ReferredToType	fromExternalString(java.lang.String externalString) Returns the Link.ReferredToType element specified by the externalString .
static Link.ReferredToType[]	getValues() Returns an array of all of the elements in this enumeration.
DataType	toDataType() Returns the DataType that should be used for creating an appropriate Id value for this "referred to" type value.

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

CONTENT

public static final Link.ReferredToType CONTENT

COURSE_ASSESSMENT

public static final Link.ReferredToType COURSE_ASSESSMENT

COURSE_TOC

public static final Link.ReferredToType COURSE_TOC

FORUM

public static final Link.ReferredToType FORUM

TOOL

public static final Link.ReferredToType TOOL

DEFAULT

public static final Link.ReferredToType DEFAULT

Method Detail

toDataType

public DataType toDataType()

Returns the DataType that should be used for creating an appropriate Id value for this "referred to" type value. A "referred to" type value indicates that this Link is pointing to a particular type of data object. The DataType returned from this method is the appropriate value for creating an Id to reference the data object

getValues

public static Link.ReferredToType[] getValues()

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

fromExternalString

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

Returns the Link.ReferredToType 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.