|
||||||||||
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.Content blackboard.data.content.CourseDocument
public class CourseDocument
The CourseDocument
class is a representation of a course document
within the Bb Course Management System. A document is the basic object added to
course materials.
Nested Class Summary | |
---|---|
static class |
CourseDocument.Area
Deprecated. Content areas are no longer used within the course environment. Instead, CourseToc objects are used, which point
to different top level folders |
static class |
CourseDocument.Type
Deprecated. This enumeration is superceded by Content.RenderType |
Nested classes/interfaces inherited from class blackboard.data.content.Content |
---|
Content.RenderType |
Field Summary | |
---|---|
static DataType |
COURSE_DOCUMENT_DATA_TYPE
Deprecated. Use the constant DATA_TYPE instead |
static DataType |
DATA_TYPE
|
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 | |
---|---|
CourseDocument()
Default constructor. |
Method Summary | |
---|---|
CourseDocument.Area |
getArea()
Deprecated. The document areas are no longer statically defined. Instead you need to look up the course toc entries |
Id |
getAsmtId()
Deprecated. The links to other objects in the system have been generalized. The preferred method is to use the Link object. This
method will always return Id.UNSET_ID |
DataType |
getDataType()
Returns the DataType identifier for this object. |
java.util.Calendar |
getRestrictionEndDate()
Returns the date up until which this CourseDocument should be
made available for viewing within the user interface. |
java.util.Calendar |
getRestrictionStartDate()
Returns the date after which this CourseDocument should be
made available for viewing within the user interface. |
CourseDocument.Type |
getType()
Deprecated. This attribute is no longer used in Blackboard 6. null
will be returned. |
void |
setArea(CourseDocument.Area eArea)
Deprecated. The document areas are no longer statically defined. Instead you need to look up the course toc entries |
void |
setAsmtId(Id iAsmtId)
Deprecated. References to other objects have been generalized through the Link . Use this object to create a "link" from a course
document to an assessment instead. This method does no work. |
void |
setRestrictionEndDate(java.util.Calendar cRestrictionEndDate)
Sets the date up until which this CourseDocument should be made
available for viewing within the user interface. |
void |
setRestrictionStartDate(java.util.Calendar cRestrictionStartDate)
Sets the date after which this CourseDocument should be made
available for viewing within the user interface. |
void |
setType(CourseDocument.Type eType)
Deprecated. This attribute is no longer used in Blackboard 6. This method will be a no-op. |
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 DataType COURSE_DOCUMENT_DATA_TYPE
DATA_TYPE
insteadConstructor Detail |
---|
public CourseDocument()
Method Detail |
---|
public Id getAsmtId()
Link
object. This
method will always return Id.UNSET_ID
Id
associated with this
CourseDocument
.
Id
value for this course documentpublic void setAsmtId(Id iAsmtId)
Link
. Use this object to create a "link" from a course
document to an assessment instead. This method does no work.
Id
value for this CourseDocument
.
iAsmtId
- the assessment Id
value to use for this course
documentpublic CourseDocument.Area getArea()
CourseDocument
.
CourseDocument.Area
. Because Areas
are no longer defined, this method will always return null.CourseToc
,
CourseTocDbLoader
public void setArea(CourseDocument.Area eArea)
CourseDocument
.
eCourseDocumentType
- a valid type value as defined in CourseDocument.Area
CourseDocument.Area
public java.util.Calendar getRestrictionStartDate()
CourseDocument
should be
made available for viewing within the user interface. This method is a
synonym for Content.getStartDate()
Calendar
representing the date after which this course
document should be made available for viewinggetRestrictionEndDate()
public void setRestrictionStartDate(java.util.Calendar cRestrictionStartDate)
CourseDocument
should be made
available for viewing within the user interface. This method is a synonym
for Content.getStartDate()
cRestrictionStartDate
- a Calendar
to use for the date after
which this course document should be available for viewingsetRestrictionEndDate(Calendar)
public java.util.Calendar getRestrictionEndDate()
CourseDocument
should be
made available for viewing within the user interface. This method is a synonym
for Content.setEndDate()
Calendar
representing the date up until which this course
document should be made available for viewinggetRestrictionStartDate()
public void setRestrictionEndDate(java.util.Calendar cRestrictionEndDate)
CourseDocument
should be made
available for viewing within the user interface. This method is a synonym for
Content.setEndDate()
cRestrictionEndDate
- a Calendar
to use for the date up until
which this course document should be available for viewingsetRestrictionStartDate(Calendar)
public CourseDocument.Type getType()
null
will be returned.
CourseDocument
.
CourseDocument.Type
CourseDocument.Type
public void setType(CourseDocument.Type eType)
CourseDocument
.
eType
- a valid type value as defined in CourseDocument.Type
CourseDocument.Type
public 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 Content
DataType
for this object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |