blackboard.data
Interface IBbObject

All Known Implementing Classes:

AggregateReviewStatus, Announcement, BbObject, CalendarEntry, Cartridge, ChildFile, Content, ContentFile, ContentFileRef, ContentFolder, ContentStatus, Course, CourseDocument, CourseLink, CourseMembership, CourseToc, CourseUpload, ExternalLink, Group, GroupMembership, GroupUpload, Lesson, Lineitem, Link, Organization, PortalRole, Score, StaffInfo, StaffInfoFolder, Upload, UploadedFile, User, UserInfo, UserRole

public interface IBbObject

The IBbObject class is an interface representing the root of the data class hierarchy. All data objects have BbObject as a superclass. It contains a set of members and methods that all data objects inherit.

Since:

Bb 6.0

Version:

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

Method Summary

BbAttributes	getBbAttributes() Returns the BbAttributes associated with this IBbObject.
java.util.Calendar	getCreatedDate() Deprecated.
DataType	getDataType() Returns the DataType identifier for the given IBbObject-derived object.
Id	getId() Returns the Id associated with this IBbObject.
java.util.Calendar	getModifiedDate() Returns the date on which this IBbObject was last modified.
void	setCreatedDate(java.util.Calendar cCreatedDate) Deprecated.
void	setId(Id iId) Sets the Id value for this IBbObject.
void	setModifiedDate(java.util.Calendar cModifiedDate) Sets the last modified date for this IBbObject.
void	validate() Validates the contents of this IBbObject.

Method Detail

getBbAttributes

BbAttributes getBbAttributes()

Returns the BbAttributes associated with this IBbObject.

Returns:

BbAttributes value for this IBbObject

getId

Id getId()

Returns the Id associated with this IBbObject.

Returns:

Id value for this IBbObject

setId

void setId(Id iId)

Sets the Id value for this IBbObject.

Parameters:

iId - an Id value to use for this IBbObject

getCreatedDate

java.util.Calendar getCreatedDate()

Deprecated.

In Bb6, schema level changes have caused a created date value to no longer be a reliable property of all Blackboard objects. As a result, this method should no longer be used as its behavior can not be guaranteed.

setCreatedDate

void setCreatedDate(java.util.Calendar cCreatedDate)

Deprecated.

In Bb6, schema level changes have caused a created date value to no longer be a reliable property of all Blackboard objects. As a result, this method should no longer be used as its behavior can not be guaranteed.

getModifiedDate

java.util.Calendar getModifiedDate()

Returns the date on which this IBbObject was last modified.

Returns:

a Calendar representing the modified date of this IBbObject

setModifiedDate

void setModifiedDate(java.util.Calendar cModifiedDate)

Sets the last modified date for this IBbObject.

The modified date value is controlled by the database (automatically updated by) and should generally not be directly manipulated by code.

Parameters:

cModifiedDate - a Calendar to use for the modified date

getDataType

DataType getDataType()

Returns the DataType identifier for the given IBbObject-derived object. Can be used to uniquely identify the "type" of a data object.

Returns:

the DataType for current object

validate

void validate()
              throws ValidationException

Validates the contents of this IBbObject. Internal consistency checks are also performed.

Throws:

ValidationException - if validation of this object fails