blackboard.data.discussionboard
Class Conference

java.lang.Object
  blackboard.data.BbObject
      blackboard.data.discussionboard.Conference

All Implemented Interfaces:

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

public class Conference
extends BbObject
implements Available, Positionable

The Conference class is a representation of a conference within the Bb Course Management System. A Conference acts as a container for various discussion forums. each course/organization/group has a default "Conference". The System Discussionboard is a collection of "Conferences". In product specification, "A Conference" is always mentioned as "A Discussionboard".

Since:

Bb 5.5

Version:

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

Field Summary

static DataType

DATA_TYPE

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Fields inherited from interface blackboard.data.Positionable

POS_UNDEFINED

Constructor Summary

Conference()
Creates an instance of Conference wiht default property values.

Method Summary

java.lang.String	getArea() Returns the area associated with this Conference
int	getAvgPostPosition() Returns the average post position associated with this Conference
int	getAvgPostSize() Returns the average post size associated with this Conference
Id	getConferenceOwnerId() Returns the ConferenceOwner Id associated with this piece of Conference
Id	getCourseId() Returns the course Id associated with this piece of Conference
DataType	getDataType() Returns the DataType identifier for this object.
FormattedText	getDescription() Returns the description of this Conference
Id	getGroupId() Returns the group Id associated with this Conference
BbFile	getIcon() Returns the icon associated with this Conference
boolean	getIsAvailable() Returns whether this Conference is available.
int	getMaxPostSize() Returns the maximum post size associated with this Conference
int	getMinPostSize() Returns the minimum post size associated with this Conference
java.lang.String	getMostRecentPost() Returns the most recent post date associated with this Conference
ConferenceOwner	getOwner() Returns the ConferenceOwner associated with this piece of Conference
ConferenceOwner.OwnerType	getOwnerType() Returns the ConferenceOwner type associated with this piece of Conference
int	getPosition() Returns the position of this Conference.
ConferenceStatus	getStatus() Returns the ConferenceStatus associated with this Conference
java.lang.String	getTitle() Returns the title associated with this Conference
void	setArea(java.lang.String strArea) Sets the area value for this Conference
void	setAvgPostPosition(int avgPostPosition) Sets the average post positon for this Conference
void	setAvgPostSize(int avgPostSize) Sets the average post size for this Conference
void	setConferenceOwnerId(Id iOwnerId) Sets the ConferenceOwner Id value for this Conference
void	setCourseId(Id iCourseId) Sets the course Id value for this Conference
void	setDescription(FormattedText desc) Sets the description of this Conference
void	setGroupId(Id iGroupId) Sets the group Id value for this Conference
void	setIcon(BbFile iconFile) Sets the icon value for this Conference
void	setIsAvailable(boolean bIsAvailable) Sets whether this Conference is available.
void	setMaxPostSize(int maxPostSize) Sets the maximum post size for this Conference
void	setMinPostSize(int minPostSize) Sets the minimum post size for this Conference
void	setMostRecentPost(java.lang.String mostRecentPost) Sets the most recent post date for this Conference
void	setOwner(ConferenceOwner owner) Sets the ConferenceOwner value for this Conference
void	setPosition(int nPos) Sets the position of this Conference.
void	setStatus(ConferenceStatus status) Sets the ConferenceStatus value for this Conference
void	setTitle(java.lang.String strTitle) Sets the title associated with this Conference
void	validate() Validates the contents of this Conference.

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

Constructor Detail

Conference

public Conference()

Creates an instance of Conference wiht default property values.

Method Detail

getOwner

public ConferenceOwner getOwner()

Returns the ConferenceOwner associated with this piece of Conference

Returns:

ConferenceOwner value for this conference

setOwner

public void setOwner(ConferenceOwner owner)

Sets the ConferenceOwner value for this Conference

Parameters:

owner - the ConferenceOwner value to use for this conference

getConferenceOwnerId

public Id getConferenceOwnerId()

Returns the ConferenceOwner Id associated with this piece of Conference

Returns:

ConferenceOwner Id value for this conference

setConferenceOwnerId

public void setConferenceOwnerId(Id iOwnerId)

Sets the ConferenceOwner Id value for this Conference

Parameters:

iOwnerId - the ConferenceOwner Id value to use for this conference

getCourseId

public Id getCourseId()

Returns the course Id associated with this piece of Conference

Returns:

course Id value for this conference

setCourseId

public void setCourseId(Id iCourseId)

Sets the course Id value for this Conference

Parameters:

iCourseId - the course Id value to use for this conference

getOwnerType

public ConferenceOwner.OwnerType getOwnerType()

Returns the ConferenceOwner type associated with this piece of Conference

Returns:

ConferenceOwner type for this conference

getGroupId

public Id getGroupId()

Returns the group Id associated with this Conference

Returns:

group Id value for this Conference

setGroupId

public void setGroupId(Id iGroupId)

Sets the group Id value for this Conference

Parameters:

iGroupId - a group Id value to use for this Conference

getArea

public java.lang.String getArea()

Returns the area associated with this Conference

Returns:

area value for this Conference as a String

setArea

public void setArea(java.lang.String strArea)

Sets the area value for this Conference

Parameters:

strArea - an area String value to use for this Conference

getIcon

public BbFile getIcon()

Returns the icon associated with this Conference

Returns:

icon value for this Conference

setIcon

public void setIcon(BbFile iconFile)

Sets the icon value for this Conference

Parameters:

iconFile - the icon value to use for this Conference

getIsAvailable

public boolean getIsAvailable()

Returns whether this Conference is available.

Specified by:

getIsAvailable in interface Available

Returns:

true if this conference is available, false otherwise

setIsAvailable

public void setIsAvailable(boolean bIsAvailable)

Sets whether this Conference is available.

Specified by:

setIsAvailable in interface Available

Parameters:

bIsAvailable - true if this conference is available, false otherwise

getPosition

public int getPosition()

Returns the position of this Conference. Position values are zero-based (the first element has a position value of zero, not one).

Specified by:

getPosition in interface Positionable

Returns:

the position of this conference within its current context. If this value has not been set or is unknown its value will be Positionable.POS_UNDEFINED.

setPosition

public void setPosition(int nPos)

Sets the position of this Conference. Position values are zero-based (the first element has a position value of zero, not one).

Specified by:

setPosition in interface Positionable

Parameters:

nPos - the new position value of this conference. This value should be a positive value.

getTitle

public java.lang.String getTitle()

Returns the title associated with this Conference

Returns:

the title value of this conference as a String

setTitle

public void setTitle(java.lang.String strTitle)

Sets the title associated with this Conference

Parameters:

strTitle - a String containing the title for this conference

getDescription

public FormattedText getDescription()

Returns the description of this Conference

Returns:

a {FormattedText} representing the description of this conference

setDescription

public void setDescription(FormattedText desc)

Sets the description of this Conference

Parameters:

desc - a FormattedText containing the description of this conference

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

Specified by:

getDataType in class BbObject

Returns:

the DataType for this object

setStatus

public void setStatus(ConferenceStatus status)

Sets the ConferenceStatus value for this Conference

Parameters:

status - the ConferenceStatus value to use for this Conference

getStatus

public ConferenceStatus getStatus()

Returns the ConferenceStatus associated with this Conference

Returns:

the ConferenceStatus value of this conference

getMostRecentPost

public java.lang.String getMostRecentPost()

Returns the most recent post date associated with this Conference

Returns:

the most recent post date of this conference as a String

setMostRecentPost

public void setMostRecentPost(java.lang.String mostRecentPost)

Sets the most recent post date for this Conference

Parameters:

mostRecentPost - the most recent post value to use for this Conference

getMinPostSize

public int getMinPostSize()

Returns the minimum post size associated with this Conference

Returns:

the minimum post size of this conference

setMinPostSize

public void setMinPostSize(int minPostSize)

Sets the minimum post size for this Conference

Parameters:

minPostSize - the minimum post size to use for this Conference

getMaxPostSize

public int getMaxPostSize()

Returns the maximum post size associated with this Conference

Returns:

the maximum post size of this conference

setMaxPostSize

public void setMaxPostSize(int maxPostSize)

Sets the maximum post size for this Conference

Parameters:

maxPostSize - the maximum post size to use for this Conference

getAvgPostSize

public int getAvgPostSize()

Returns the average post size associated with this Conference

Returns:

the average post size of this conference

setAvgPostSize

public void setAvgPostSize(int avgPostSize)

Sets the average post size for this Conference

Parameters:

avgPostSize - the average post size to use for this Conference

getAvgPostPosition

public int getAvgPostPosition()

Returns the average post position associated with this Conference

Returns:

the average post position of this conference

setAvgPostPosition

public void setAvgPostPosition(int avgPostPosition)

Sets the average post positon for this Conference

Parameters:

avgPostPosition - the average post position to use for this Conference

validate

public void validate()
              throws ValidationException

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

Specified by:

validate in interface IBbObject

Overrides:

validate in class BbObject

Throws:

ValidationException - if validation of this object fails