blackboard.data.content
Class Link.ReferrerType

java.lang.Object
  extended by blackboard.base.BbEnum
      extended by blackboard.data.content.Link.ReferrerType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<java.lang.Object>
Enclosing class:
Link

public static final class Link.ReferrerType
extends BbEnum
implements java.io.Serializable

See Also:
Serialized Form

Field Summary
static Link.ReferrerType ANNOUNCEMENT
           
static Link.ReferrerType CONTENT
           
static Link.ReferrerType COURSE_TOC
           
static Link.ReferrerType DEFAULT
           
 
Method Summary
static Link.ReferrerType fromExternalString(java.lang.String externalString)
          Returns the Link.ReferrerType element specified by the externalString .
static Link.ReferrerType[] 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 "referrer" type value.
 
Methods inherited from class blackboard.base.BbEnum
compareTo, defineAlias, defineDefault, fromExternalString, fromFieldName, fromFieldName, getDefaultElement, getFieldName, 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

ANNOUNCEMENT

public static final Link.ReferrerType ANNOUNCEMENT

CONTENT

public static final Link.ReferrerType CONTENT

COURSE_TOC

public static final Link.ReferrerType COURSE_TOC

DEFAULT

public static final Link.ReferrerType DEFAULT
Method Detail

toDataType

public DataType toDataType()
Returns the DataType that should be used for creating an appropriate Id value for this "referrer" type value. A "referrer" type value indicates that this Link is contained by 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.ReferrerType[] getValues()
Returns an array of all of the elements in this enumeration.


fromExternalString

public static Link.ReferrerType fromExternalString(java.lang.String externalString)
                                            throws java.lang.IllegalArgumentException
Returns the Link.ReferrerType element specified by the externalString .

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


Copyright © 2012 Blackboard, Inc. All Rights Reserved.