blackboard.data.course
Class Group

java.lang.Object
  blackboard.data.BbObject
      blackboard.data.course.Group

All Implemented Interfaces:

Available, IBbObject, java.lang.Cloneable

public class Group
extends BbObject
implements Available

The Group class is a representation of a course group within the Course Management System.

Since:

Bb 5.5

Version:

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

Field Summary

static DataType

DATA_TYPE

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

Group()
Creates an instance of Group with default property values.

Method Summary

Id	getCourseId() Returns the course Id associated with this Group
DataType	getDataType() Returns the DataType identifier for this object.
FormattedText	getDescription() Returns the description of this Group
boolean	getIsAvailable() Returns whether this Group is available.
boolean	getIsChatRoomAvailable() Returns whether the chat room should be enabled for this Group.
boolean	getIsDiscussionBoardAvailable() Returns whether the discussion board should be enabled for this Group .
boolean	getIsEmailAvailable() Returns whether email should be enabled for this Group.
boolean	getIsTransferAreaAvailable() Returns whether the transfer area should be enabled for this Group .
java.lang.String	getTitle() Returns the title associated with this Group
void	setCourseId(Id iCourseId) Sets the course Id value for this Group
void	setDescription(FormattedText desc) Sets the description of this Group
void	setIsAvailable(boolean bIsAvailable) Sets whether this Group is available.
void	setIsChatRoomAvailable(boolean bIsChatRoomAvailable) Sets whether the chat room should be enabled for this Group.
void	setIsDiscussionBoardAvailable(boolean bIsDiscussionBoardAvailable) Sets whether the discussion board should be enabled for this Group .
void	setIsEmailAvailable(boolean bIsEmailAvailable) Sets whether email should be enabled for this Group.
void	setIsTransferAreaAvailable(boolean bIsTransferAreaAvailable) Sets whether the transfer area should be enabled for this Group.
void	setTitle(java.lang.String strTitle) Sets the title associated with this Group

Methods inherited from class blackboard.data.BbObject

clone, getBbAttributes, getCreatedDate, getId, getModifiedDate, persist, setCreatedDate, setId, setModifiedDate, toString, validate

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

Group

public Group()

Creates an instance of Group with default property values.

Method Detail

getCourseId

public Id getCourseId()

Returns the course Id associated with this Group

Returns:

course Id value for this group

setCourseId

public void setCourseId(Id iCourseId)

Sets the course Id value for this Group

Parameters:

iCourseId - the course Id value to use for this group

getIsAvailable

public boolean getIsAvailable()

Returns whether this Group is available.

Specified by:

getIsAvailable in interface Available

Returns:

true if this group is available, false otherwise

setIsAvailable

public void setIsAvailable(boolean bIsAvailable)

Sets whether this Group is available.

Specified by:

setIsAvailable in interface Available

Parameters:

bIsAvailable - true if this group is available, false otherwise

getIsChatRoomAvailable

public boolean getIsChatRoomAvailable()

Returns whether the chat room should be enabled for this Group.

Returns:

true if the chat room should be available to this group, false otherwise

setIsChatRoomAvailable

public void setIsChatRoomAvailable(boolean bIsChatRoomAvailable)

Sets whether the chat room should be enabled for this Group.

Parameters:

bIsChatRoomAvailable - true if the chat room should be available to this group, false otherwise

getIsDiscussionBoardAvailable

public boolean getIsDiscussionBoardAvailable()

Returns whether the discussion board should be enabled for this Group .

Returns:

true if the discussion board should be available to this group, false otherwise

setIsDiscussionBoardAvailable

public void setIsDiscussionBoardAvailable(boolean bIsDiscussionBoardAvailable)

Sets whether the discussion board should be enabled for this Group .

Parameters:

bIsDiscussionBoardAvailable - true if the discussion board should be available to this group, false otherwise

getIsEmailAvailable

public boolean getIsEmailAvailable()

Returns whether email should be enabled for this Group.

Returns:

true if email should be available to this group, false otherwise

setIsEmailAvailable

public void setIsEmailAvailable(boolean bIsEmailAvailable)

Sets whether email should be enabled for this Group.

Parameters:

bIsEmailAvailable - true if the email should be available to this group, false otherwise

getIsTransferAreaAvailable

public boolean getIsTransferAreaAvailable()

Returns whether the transfer area should be enabled for this Group .

Returns:

true if the transfer area should be available to this group, false otherwise

setIsTransferAreaAvailable

public void setIsTransferAreaAvailable(boolean bIsTransferAreaAvailable)

Sets whether the transfer area should be enabled for this Group.

Parameters:

bIsTransferAreaAvailable - true if the transfer area should be available to this group, false otherwise

getTitle

public java.lang.String getTitle()

Returns the title associated with this Group

Returns:

the title value of this group as a String

setTitle

public void setTitle(java.lang.String strTitle)

Sets the title associated with this Group

Parameters:

strTitle - a String containing the title for this group

getDescription

public FormattedText getDescription()

Returns the description of this Group

Returns:

a {FormattedText} representing the description of this group

setDescription

public void setDescription(FormattedText desc)

Sets the description of this Group

Parameters:

desc - a FormattedText containing the description of this group

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 class BbObject

Returns:

the DataType for this object