blackboard.data.content
Class Link

java.lang.Object
  blackboard.data.BbObject
      blackboard.data.content.Link

All Implemented Interfaces:

Available, IBbObject, Identifiable, java.lang.Cloneable

public class Link
extends BbObject
implements Available

The Link class is a representation of a link within the Blackboard application. A link represents a "shortcut" (or reference) from one part of a course to another part of the same course.

Since:

Bb 6.0

Version:

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

Nested Class Summary

static class	Link.ReferredToType
static class	Link.ReferrerType

Field Summary

static DataType

DATA_TYPE

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

Link()
Creates an instance of Link with default property values.

Method Summary

DataType	getDataType() Returns the DataType identifier for the given BbObject-derived object.
boolean	getIsAvailable() Returns the availability flag for this Link.
Id	getReferredToId() Returns the referred to Id associated with this Link .
Link.ReferredToType	getReferredToType() Returns the referred to type for this Link.
Id	getReferrerId() Returns the referrer Id associated with this Link.
Link.ReferrerType	getReferrerType() Returns the referrer type for this Link.
java.lang.String	getTitle() Returns the title associated with this Link.
void	setIsAvailable(boolean bIsAvailable) Sets the availability flag for this Link.
void	setReferredToId(Id iReferredToId) Sets the internal Blackboard id of the destination ("referred to") object of this Link.
void	setReferredToType(Link.ReferredToType eReferredToType) Sets the referrer type for this Link.
void	setReferrerId(Id iReferrerId) Sets the Internal blackboard id of the source (referrer) object of this Link.
void	setReferrerType(Link.ReferrerType eReferrerType) Sets the referrer type for this Link.
void	setTitle(java.lang.String strTitle) Sets the title associated with this Link.
void	validate() Validates the contents of this Link.

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

Constructor Detail

Link

public Link()

Creates an instance of Link with default property values.

Method Detail

getTitle

public java.lang.String getTitle()

Returns the title associated with this Link.

Returns:

the title value of this link as a String

setTitle

public void setTitle(java.lang.String strTitle)

Sets the title associated with this Link.

Parameters:

strTitle - a String containing the title for this link

getIsAvailable

public boolean getIsAvailable()

Returns the availability flag for this Link.

Specified by:

getIsAvailable in interface Available

Returns:

a boolean denoted whether this Link is available

setIsAvailable

public void setIsAvailable(boolean bIsAvailable)

Sets the availability flag for this Link. This method is used when populating the value from the database. It should not be used directly.

Specified by:

setIsAvailable in interface Available

Parameters:

bIsAvailable - true if the link is to be made available, false otherwise.

getReferrerId

public Id getReferrerId()

Returns the referrer Id associated with this Link. This Id represents the id of the object that is the "starting" point of the link -- the object that will "contain" this link as a reference to another object in the system.

Returns:

Id value for the referrer of this Link

setReferrerId

public void setReferrerId(Id iReferrerId)

Sets the Internal blackboard id of the source (referrer) object of this Link. This Id represents the id of the object that is the "starting" point of the link -- the object that will "contain" this link as a reference to another object in the system. The Id must belong to a valid blackboard content object (Announcement, Course Content, or Course TOC) or any attempts to persist the link will result in a generated exception.

Parameters:

iReferrerId - an Id value to use as the referrer id of this Link

getReferrerType

public Link.ReferrerType getReferrerType()

Returns the referrer type for this Link. This identifies the "type" of object that will "contain" this link.

Returns:

a referrer type value as defined in Link.ReferrerType

See Also:

Link.ReferrerType

setReferrerType

public void setReferrerType(Link.ReferrerType eReferrerType)

Sets the referrer type for this Link. This identifies the "type" of object that will "contain" this link.

Parameters:

eReferrerType - a valid referrer type value as defined in Link.ReferrerType

See Also:

Link.ReferrerType

getReferredToId

public Id getReferredToId()

Returns the referred to Id associated with this Link . This Id represents the id of the object that is the "ending" point of the link -- the object that this link "points" to.

Returns:

Id value for the referred to object of this Link

setReferredToId

public void setReferredToId(Id iReferredToId)

Sets the internal Blackboard id of the destination ("referred to") object of this Link. This Id represents the id of the object that is the "ending" point of the link -- the object that this link "points" to. The Id must belong to a valid blackboard content object or any attempts to persist the link will result in a generated exception.

Parameters:

iReferredToId - an Id value to use as the referrer id of this Link

getReferredToType

public Link.ReferredToType getReferredToType()

Returns the referred to type for this Link. This identifies the "type" of object that will be "pointed" to (referred to) by this link.

Returns:

a referred to type value as defined in Link.ReferredToType

See Also:

Link.ReferredToType

setReferredToType

public void setReferredToType(Link.ReferredToType eReferredToType)

Sets the referrer type for this Link. This identifies the "type" of object that will be "pointed" to (referred to) by this link.

Parameters:

eReferredToType - a valid referred to type value as defined in Link.ReferredToType

See Also:

Link.ReferredToType

getDataType

public DataType getDataType()

Returns the DataType identifier for the given BbObject-derived object. Can be used to uniquely identify the "type" of a data object.

Specified by:

getDataType in interface IBbObject

Specified by:

getDataType in interface Identifiable

Specified by:

getDataType in class BbObject

Returns:

the DataType for current object

validate

public void validate()
              throws ValidationException

Validates the contents of this Link. Internal consistency checks are also performed.

Specified by:

validate in interface IBbObject

Overrides:

validate in class BbObject

Throws:

ValidationException - if validation of this object fails