blackboard.data.content
Class ExternalLink

java.lang.Object
  blackboard.data.BbObject
      blackboard.data.content.Content
          blackboard.data.content.ExternalLink

All Implemented Interfaces:

Available, IBbObject, Identifiable, Positionable, java.lang.Cloneable

public class ExternalLink
extends Content

The ExternalLink class is a representation of an external link within the Bb Course Management System. ExternalLink objects wrap URLs.

Since:

Bb 5.5

Version:

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

Nested Class Summary

Nested classes/interfaces inherited from class blackboard.data.content.Content

Content.RenderType

Field Summary

static DataType	DATA_TYPE
static DataType	EXTERNAL_LINK_DATA_TYPE Deprecated. Use the constant DATA_TYPE instead

Fields inherited from class blackboard.data.content.Content

RESOURCE_BUNDLE

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Fields inherited from interface blackboard.data.Positionable

POS_UNDEFINED

Constructor Summary

ExternalLink()
Default constructor.

Method Summary

DataType	getDataType() Returns the DataType identifier for this object.
FormattedText	getDescription() Returns the description of this ExternalLink.
void	setDescription(FormattedText desc) Sets the description of this ExternalLink.
void	setUrl(java.net.URL url) Sets the URL associated with this ExternalLink.

Methods inherited from class blackboard.data.content.Content

addContentFile, getAllowGuests, getAllowObservers, getBody, getContentFiles, getContentHandler, getContentStatus, getCourseId, getEndDate, getIsAvailable, getIsDescribed, getIsFolder, getIsFromCartridge, getIsLesson, getIsReviewable, getIsSequential, getIsTracked, getLaunchInNewWindow, getOfflineName, getOfflinePath, getParentId, getPersistentTitle, getPosition, getRemovedFiles, getRenderType, getStartDate, getTitle, getTitleColor, getUrl, printTree, removeContentFile, removeContentFile, setAllowGuests, setAllowObservers, setBody, setContentHandler, setCourseId, setEndDate, setIsAvailable, setIsDescribed, setIsFolder, setIsFromCartridge, setIsLesson, setIsReviewable, setIsSequential, setIsTracked, setLaunchInNewWindow, setOfflineName, setOfflinePath, setParentId, setPosition, setRenderType, setStartDate, setTitle, setTitleColor, setUrl, traverseContent, validate

Methods inherited from class blackboard.data.BbObject

clone, getBbAttributes, getCreatedDate, getId, getModifiedDate, persist, setCreatedDate, setId, setModifiedDate, toString

Methods inherited from class java.lang.Object

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

Field Detail

DATA_TYPE

public static final DataType DATA_TYPE

EXTERNAL_LINK_DATA_TYPE

public static final DataType EXTERNAL_LINK_DATA_TYPE

Deprecated. Use the constant DATA_TYPE instead

Constructor Detail

ExternalLink

public ExternalLink()

Default constructor. Ensures that the appropriate content handler string is set, and defaults the LaunchInNewWindow property to false.

Method Detail

setUrl

public void setUrl(java.net.URL url)

Sets the URL associated with this ExternalLink. This field cannot exceed 255 characters. Additionally, it is not required to conform to URL syntax, and is not double checked for "live" links.

Parameters:

url - a java.net.URL containing the url for this external link

getDescription

public FormattedText getDescription()

Returns the description of this ExternalLink.

Returns:

a {FormattedText} representing the description of this external link

setDescription

public void setDescription(FormattedText desc)

Sets the description of this ExternalLink. This field has an unlimited length.

Parameters:

desc - a FormattedText containing the description of this external link

getDataType

public DataType getDataType()

Returns the DataType identifier for this object. Can be used to uniquely identify the "type" of this data object.

Specified by:

getDataType in interface IBbObject

Specified by:

getDataType in interface Identifiable

Overrides:

getDataType in class Content

Returns:

the DataType for this object