blackboard.data.discussionboard
Class ForumStatus

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

All Implemented Interfaces:

IBbObject, Identifiable, java.lang.Cloneable

public class ForumStatus
extends BbObject

The ForumStatus object wraps the state of a user's interaction with a given piece of forum and adaptive release status.

It is not a persistent object in the ordinary sense; it is loaded from the database, but combines information derived from different sources. With this in mind, one cannot "save" a ForumStatus object.

Field Summary

static DataType

DATA_TYPE

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

ForumStatus()
Default constructor.

Method Summary

java.lang.String	getAvgPostPosition() Returns the average post position
java.lang.String	getAvgPostSize() Returns the average post size
DataType	getDataType() Returns the DataType identifier for this object.
int	getForumCount() Returns the total count of forums
java.lang.String	getGrade() Returns the grade
java.lang.String	getIsEnabled() Returns whether is_enabled
java.lang.String	getMaxPostSize() Returns the maximum post size
java.lang.String	getMinPostSize() Returns the minimum post size
java.util.Calendar	getMostRecentPost() Returns the most recent post date
int	getMsgCount() Returns the number of messages a user has posted in a forum
int	getReadCount() Returns the unread count in a forum
int	getTotalCount() Returns the total count of messages in a forum
int	getTotalParticipant() Returns the total participants in a forum
int	getUnreadMessageCount() Returns the unread message count of messages in a forum
void	setAvgPostPosition(java.lang.String avg_post_position) Sets the average post positon
void	setAvgPostSize(java.lang.String avg_post_size) Sets the average post size
void	setForumCount(int forumCount) Sets the total count of forums
void	setGrade(java.lang.String grade) Sets the grade
void	setIsEnabled(java.lang.String is_enabled) Sets whether is enabled
void	setMaxPostSize(java.lang.String max_post_size) Sets the maximum post size
void	setMinPostSize(java.lang.String min_post_size) Sets the minimum post size
void	setMostRecentPost(java.util.Calendar most_recent_post) Sets the most recent post date
void	setMsgCount(int n) Sets the count for number messages a user has posted in a forum
void	setReadCount(int read_count) Sets the unread count in a forum
void	setTotalCount(int total_count) Sets the total count of messages in a forum
void	setTotalParticipant(int total_participant) Sets the total participants in a forum

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 DataType DATA_TYPE

Constructor Detail

ForumStatus

public ForumStatus()

Default constructor. This method is public because of requirements in the persistence framework. Instantiating on object in this way is not very useful, since the data cannot be persisted.

If you need to access status for a particular piece of forum, use ForumManager

Method Detail

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

getUnreadMessageCount

public int getUnreadMessageCount()

Returns the unread message count of messages in a forum

Returns:

the unread message count of messages in a forum

setTotalCount

public void setTotalCount(int total_count)

Sets the total count of messages in a forum

Parameters:

total_count - total count of messages in a forum

getTotalCount

public int getTotalCount()

Returns the total count of messages in a forum

Returns:

the total count of messages in a forum

getMsgCount

public int getMsgCount()

Returns the number of messages a user has posted in a forum

Returns:

the number of messages a user has posted in a forum

setMsgCount

public void setMsgCount(int n)

Sets the count for number messages a user has posted in a forum

Parameters:

n -

setTotalParticipant

public void setTotalParticipant(int total_participant)

Sets the total participants in a forum

Parameters:

total_participants - total participants in a forum

getTotalParticipant

public int getTotalParticipant()

Returns the total participants in a forum

Returns:

the total count of participants in a forum

setReadCount

public void setReadCount(int read_count)

Sets the unread count in a forum

Parameters:

unread_count - unread count in a forum

getReadCount

public int getReadCount()

Returns the unread count in a forum

Returns:

the total count of participants in a forum

setIsEnabled

public void setIsEnabled(java.lang.String is_enabled)

Sets whether is enabled

Parameters:

is_enabled - Y if is enabled, N otherwise

getIsEnabled

public java.lang.String getIsEnabled()

Returns whether is_enabled

Returns:

Y if is enabled, N otherwise

setMostRecentPost

public void setMostRecentPost(java.util.Calendar most_recent_post)

Sets the most recent post date

Parameters:

most_recent_post - the most recent post date

getMostRecentPost

public java.util.Calendar getMostRecentPost()

Returns the most recent post date

Returns:

the most recent post date

setMinPostSize

public void setMinPostSize(java.lang.String min_post_size)

Sets the minimum post size

Parameters:

min_post_size - the minimum post size

getMinPostSize

public java.lang.String getMinPostSize()

Returns the minimum post size

Returns:

the minimum post size

setMaxPostSize

public void setMaxPostSize(java.lang.String max_post_size)

Sets the maximum post size

Parameters:

max_post_size - the maximum post size

getMaxPostSize

public java.lang.String getMaxPostSize()

Returns the maximum post size

Returns:

the maximum post size

setAvgPostSize

public void setAvgPostSize(java.lang.String avg_post_size)

Sets the average post size

Parameters:

avg_post_size - the average post size

getAvgPostSize

public java.lang.String getAvgPostSize()

Returns the average post size

Returns:

the average post size

setAvgPostPosition

public void setAvgPostPosition(java.lang.String avg_post_position)

Sets the average post positon

Parameters:

avg_post_position - the average post position

getAvgPostPosition

public java.lang.String getAvgPostPosition()

Returns the average post position

Returns:

the average post position

setGrade

public void setGrade(java.lang.String grade)

Sets the grade

Parameters:

grade - the grade

getGrade

public java.lang.String getGrade()

Returns the grade

Returns:

the grade

setForumCount

public void setForumCount(int forumCount)

Sets the total count of forums

Parameters:

forumCount - total count of forums

getForumCount

public int getForumCount()

Returns the total count of forums

Returns:

the total count of forums