blackboard.data.content
Class CourseDocument

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

All Implemented Interfaces:

Available, HasExtendedData, IBbObject, Identifiable, Positionable, java.io.Serializable, 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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class blackboard.data.content.Content

Content.ContentView, Content.RenderType

Field Summary

static DataType

DATA_TYPE

Fields inherited from class blackboard.data.content.Content

COURSELINK_HANDLER, ICON_URL, 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

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

Methods inherited from class blackboard.data.content.Content

addContentFile, getAllowGuests, getAllowObservers, getBody, getContentFiles, getContentHandler, getContentStatus, getCourseId, getEndDate, getExtendedData, getGradebookItem, getIsAvailable, getIsDescribed, getIsFolder, getIsFromCartridge, getIsGroupContent, getIsLesson, getIsReviewable, getIsSampleContent, getIsSequential, getIsTracked, getLaunchInNewWindow, getLinkRef, getLinkTargetIconUrl, getOfflineName, getOfflinePath, getParentId, getPersistentTitle, getPosition, getRemovedFiles, getRenderType, getStartDate, getTitle, getTitleColor, getUrl, getUrlHost, getViewMode, printTree, removeContentFile, removeContentFile, removeInternalArtifacts, setAllowGuests, setAllowObservers, setBody, setContentHandler, setContentStatus, setCourseId, setEndDate, setExtendedData, setIsAvailable, setIsDescribed, setIsFolder, setIsFromCartridge, setIsGroupContent, setIsLesson, setIsReviewable, setIsSampleContent, setIsSequential, setIsTracked, setLaunchInNewWindow, setLinkRef, setOfflineName, setOfflinePath, setParentId, setPosition, setRenderType, setStartDate, setTitle, setTitleColor, setUrl, setViewMode, traverseContent, validate

Methods inherited from class blackboard.data.BbObject

clone, getBbAttributes, getCreatedDate, getId, getModifiedDate, matches, 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

CourseDocument

public CourseDocument()

Default constructor.

Method Detail

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)

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