blackboard.data.content
Class CourseDocument

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

All Implemented Interfaces:

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

public class CourseDocument
extends Content

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.

Since:

Bb 5.5

Version:

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

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.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

COURSE_DOCUMENT_DATA_TYPE

public static final DataType COURSE_DOCUMENT_DATA_TYPE

Deprecated. Use the constant DATA_TYPE instead

Constructor Detail

CourseDocument

public CourseDocument()

Default constructor.

Method Detail

getAsmtId

public 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

Returns the assessment Id associated with this CourseDocument.

Returns:

assessment Id value for this course document

setAsmtId

public 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.

Sets the assessment Id value for this CourseDocument .

Parameters:

iAsmtId - the assessment Id value to use for this course document

getArea

public CourseDocument.Area getArea()

Deprecated. The document areas are no longer statically defined. Instead you need to look up the course toc entries

Returns the area value for this CourseDocument.

Returns:

a area value as defined in CourseDocument.Area. Because Areas are no longer defined, this method will always return null.

See Also:

CourseToc, CourseTocDbLoader

setArea

public void setArea(CourseDocument.Area eArea)

Deprecated. The document areas are no longer statically defined. Instead you need to look up the course toc entries

Sets the area value for this CourseDocument.

Parameters:

eCourseDocumentType - a valid type value as defined in CourseDocument.Area

See Also:

CourseDocument.Area

getRestrictionStartDate

public java.util.Calendar getRestrictionStartDate()

Returns the date after which this CourseDocument should be made available for viewing within the user interface. This method is a synonym for Content.getStartDate()

Returns:

a Calendar representing the date after which this course document should be made available for viewing

See Also:

getRestrictionEndDate()

setRestrictionStartDate

public void setRestrictionStartDate(java.util.Calendar cRestrictionStartDate)

Sets the date after which this CourseDocument should be made available for viewing within the user interface. This method is a synonym for Content.setStartDate()

Parameters:

cRestrictionStartDate - a Calendar to use for the date after which this course document should be available for viewing

See Also:

setRestrictionEndDate(Calendar)

getRestrictionEndDate

public java.util.Calendar getRestrictionEndDate()

Returns the date up until which this CourseDocument should be made available for viewing within the user interface. This method is a synonym for Content.getEndDate()

Returns:

a Calendar representing the date up until which this course document should be made available for viewing

See Also:

getRestrictionStartDate()

setRestrictionEndDate

public void setRestrictionEndDate(java.util.Calendar cRestrictionEndDate)

Sets the date up until which this CourseDocument should be made available for viewing within the user interface. This method is a synonym for Content.setEndDate()

Parameters:

cRestrictionEndDate - a Calendar to use for the date up until which this course document should be available for viewing

See Also:

setRestrictionStartDate(Calendar)

getType

public CourseDocument.Type getType()

Deprecated. This attribute is no longer used in Blackboard 6. null will be returned.

Returns the type value associated with this CourseDocument.

Returns:

a type value as defined in CourseDocument.Type

See Also:

CourseDocument.Type

setType

public void setType(CourseDocument.Type eType)

Deprecated. This attribute is no longer used in Blackboard 6. This method will be a no-op.

Sets the type value associated with this CourseDocument.

Parameters:

eType - a valid type value as defined in CourseDocument.Type

See Also:

CourseDocument.Type

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