|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object blackboard.data.BbObject blackboard.data.content.Link
public class Link
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.
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 . |
Methods inherited from class blackboard.data.BbObject |
---|
clone, getBbAttributes, getCreatedDate, getId, getModifiedDate, persist, setCreatedDate, setId, setModifiedDate, toString, validate |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final DataType DATA_TYPE
Constructor Detail |
---|
public Link()
Link
with default property values.
Method Detail |
---|
public java.lang.String getTitle()
Link
.
String
public void setTitle(java.lang.String strTitle)
Link
.
strTitle
- a String
containing the title for this linkpublic boolean getIsAvailable()
Link
.
getIsAvailable
in interface Available
Link
is availablepublic void setIsAvailable(boolean bIsAvailable)
Link
. This method is used
when populating the value from the database. It should not be used directly.
setIsAvailable
in interface Available
bIsAvailable
- true if the link is to be made available, false otherwise.public Id getReferrerId()
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.
Id
value for the referrer of this Link
public void setReferrerId(Id iReferrerId)
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.
iReferrerId
- an Id
value to use as the referrer id of this
Link
public Link.ReferrerType getReferrerType()
Link
. This identifies the
"type" of object that will "contain" this link.
Link.ReferrerType
Link.ReferrerType
public void setReferrerType(Link.ReferrerType eReferrerType)
Link
. This identifies the
"type" of object that will "contain" this link.
eReferrerType
- a valid referrer type value as defined in Link.ReferrerType
Link.ReferrerType
public Id getReferredToId()
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.
Id
value for the referred to object of this Link
public void setReferredToId(Id iReferredToId)
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.
iReferredToId
- an Id
value to use as the referrer id of this
Link
public Link.ReferredToType getReferredToType()
Link
. This identifies the
"type" of object that will be "pointed" to (referred to) by this link.
Link.ReferredToType
Link.ReferredToType
public void setReferredToType(Link.ReferredToType eReferredToType)
Link
. This identifies the
"type" of object that will be "pointed" to (referred to) by this link.
eReferredToType
- a valid referred to type value as defined in Link.ReferredToType
Link.ReferredToType
public DataType getDataType()
DataType
identifier for the given BbObject-derived
object. Can be used to uniquely identify the "type" of a data object.
getDataType
in interface IBbObject
getDataType
in class BbObject
DataType
for current object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |