|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object blackboard.data.BbObject blackboard.data.navigation.CourseToc
public class CourseToc
The CourseToc
class provides a representation of the left hand
navigation items displayed when inside a course in the Bb CMS.
Nested Class Summary | |
---|---|
static class |
CourseToc.Target
|
Field Summary | |
---|---|
static DataType |
DATA_TYPE
|
static java.lang.String |
RESOURCE_BUNDLE
Resource bundle for this data object |
Fields inherited from class blackboard.data.BbObject |
---|
_bbAttributes |
Fields inherited from interface blackboard.data.Positionable |
---|
POS_UNDEFINED |
Constructor Summary | |
---|---|
CourseToc()
Creates an instance of Course with default property values. |
Method Summary | |
---|---|
boolean |
getAllowGuests()
Returns the allow guests flag for this CourseToc . |
boolean |
getAllowObservers()
Returns the allow observers flag for this CourseToc . |
Id |
getContentId()
Returns the content Id of this CourseToc . |
Id |
getCourseId()
Returns the course Id of this CourseToc . |
DataType |
getDataType()
Returns the DataType identifier for this object. |
java.lang.String |
getInternalHandle()
Returns the internal handle associated with this CourseToc . |
boolean |
getIsEnabled()
Returns whether this CourseToc is enabled. |
boolean |
getIsEntryPoint()
Returns whether this CourseToc is an entry point. |
java.lang.String |
getLabel()
Returns the label associated with this CourseToc . |
boolean |
getLaunchInNewWindow()
Returns whether this CourseToc should be launched in a new
window (when selected within the user interface). |
java.lang.String |
getPersistentLabel()
Returns the database label associated with this CourseToc . |
int |
getPosition()
Returns the position of this CourseToc . |
CourseToc.Target |
getTargetType()
Returns the target type for this CourseToc . |
java.lang.String |
getUrl()
Returns the URL associated with this CourseToc . |
void |
setAllowGuests(boolean bAllowGuests)
Sets the allow guests flag for this CourseToc . |
void |
setAllowObservers(boolean bAllowObservers)
Sets the allow observers flag for this CourseToc . |
void |
setContentId(Id iContentId)
Sets the content Id value for this CourseToc . |
void |
setCourseId(Id iCourseId)
Sets the course Id value for this CourseToc . |
void |
setInternalHandle(java.lang.String strInternalHandle)
Sets the internal handle associated with this CourseToc . |
void |
setIsEnabled(boolean bIsEnabled)
Sets whether this CourseToc should be enabled. |
void |
setIsEntryPoint(boolean bIsEntryPoint)
Sets whether this CourseToc is an entry point. |
void |
setLabel(java.lang.String strLabel)
Sets the label associated with this CourseToc . |
void |
setLaunchInNewWindow(boolean bLaunchInNewWindow)
Sets whether this CourseToc should be launched in a new window
(when selected within the user interface). |
void |
setPosition(int nPos)
Sets the position of this CourseToc . |
void |
setTargetType(CourseToc.Target eTargetType)
Sets the target type for this CourseToc . |
void |
setUrl(java.lang.String strUrl)
Sets the URL associated with this CourseToc . |
void |
validate()
Validates the contents of this CourseToc . |
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 |
---|
public static final DataType DATA_TYPE
public static final java.lang.String RESOURCE_BUNDLE
Constructor Detail |
---|
public CourseToc()
Course
with default property values.
Method Detail |
---|
public Id getCourseId()
Id
of this CourseToc
.
Id
value for this course tocpublic void setCourseId(Id iCourseId)
Id
value for this CourseToc
.
iCourseId
- the course Id
value to use for this course tocpublic Id getContentId()
Id
of this CourseToc
.
Id
value for this course tocpublic void setContentId(Id iContentId)
Id
value for this CourseToc
.
iContentId
- the content Id
value to use for this course tocpublic java.lang.String getPersistentLabel()
CourseToc
.
String
public java.lang.String getLabel()
CourseToc
.
String
public void setLabel(java.lang.String strLabel)
CourseToc
.
strLabel
- a String
containing the label for this course tocpublic java.lang.String getUrl()
CourseToc
.
String
public void setUrl(java.lang.String strUrl)
CourseToc
.
strUrl
- a String
containing the url for this course tocpublic CourseToc.Target getTargetType()
CourseToc
.
CourseToc.Target
CourseToc.Target
public void setTargetType(CourseToc.Target eTargetType)
CourseToc
.
eTargetType
- a valid type value as defined in CourseToc.Target
CourseToc.Target
public int getPosition()
CourseToc
. This position should
be used when displaying tocs relative to each other. Position values are
zero-based (the first element has a position value of zero, not one).
getPosition
in interface Positionable
Positionable.POS_UNDEFINED
.public void setPosition(int nPos)
CourseToc
. Position values are
zero-based (the first element has a position value of zero, not one).
setPosition
in interface Positionable
nPos
- the new position value of this course toc. This value should
be a positive value.public boolean getLaunchInNewWindow()
CourseToc
should be launched in a new
window (when selected within the user interface).
public void setLaunchInNewWindow(boolean bLaunchInNewWindow)
CourseToc
should be launched in a new window
(when selected within the user interface).
bLaunchInNewWindow
- true if the course toc should be opened in a new
window, false otherwise.public boolean getIsEnabled()
CourseToc
is enabled.
public void setIsEnabled(boolean bIsEnabled)
CourseToc
should be enabled.
bIsEnabled
- true if the course toc should be enabled, false otherwise.public boolean getIsEntryPoint()
CourseToc
is an entry point.
public void setIsEntryPoint(boolean bIsEntryPoint)
CourseToc
is an entry point.
bIsEntryPoint
- true if the course toc should be an entry point, false
otherwise.public boolean getAllowObservers()
CourseToc
. This flag
determines whether or not "observers" (parents of a student in a course for
example) are allowed access to this course toc.
public void setAllowObservers(boolean bAllowObservers)
CourseToc
. This flag
determines whether or not "observers" (parents of a student in a course for
example) are allowed access to this course toc.
Course.setAllowObservers(boolean)
. However,
this setting does not override that value. Only if that value is true
is this value used to provide more control over access.
bAllowObservers
- true if observers should be allowed in this course
toc, false otherwisepublic java.lang.String getInternalHandle()
CourseToc
.
String
public void setInternalHandle(java.lang.String strInternalHandle)
CourseToc
.
strInternalHandle
- a String
containing the internal handle for
this course tocpublic boolean getAllowGuests()
CourseToc
. This flag
determines whether or not "guests" (users with the role guest) are allowed
access to this course toc.
public void setAllowGuests(boolean bAllowGuests)
CourseToc
. This flag determines
whether or not "guests" (users with the role guest) are allowed access to this
course toc.
Course.setAllowGuests(boolean)
. However, this setting
does not override that value. Only if that value is true
is this
value used to provide more control over access.
bAllowGuests
- true if guests should be allowed in this course toc, false
otherwisepublic DataType getDataType()
DataType
identifier for this object. Can be used to
uniquely identify the "type" of this data object.
getDataType
in interface IBbObject
getDataType
in class BbObject
DataType
for this objectpublic void validate() throws ValidationException
CourseToc
. Internal consistency
checks are also performed.
validate
in interface IBbObject
validate
in class BbObject
ValidationException
- if validation of this object fails
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |