blackboard.data.discussionboard
Class ForumProperties

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

All Implemented Interfaces:

IBbObject, Identifiable, java.lang.Cloneable

public class ForumProperties
extends BbObject

The ForumProperties class represents the properties to a given discussion board forum within the Bb Course Management System.

Field Summary

static DataType

DATA_TYPE

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

ForumProperties()
Default constructor.

Method Summary

java.lang.Boolean	getAllowAnonymous() Returns whether this Forum is allow anonymous.
java.lang.Boolean	getAllowAttachment() Returns whether this Forum is allow attachment.
java.lang.Boolean	getAllowCreate() Returns whether this Forum is allow create.
java.lang.Boolean	getAllowDelete() Returns whether this Forum is allow message delete.
java.lang.Boolean	getAllowDeleteTree() Returns whether this Forum is allow message tree delete.
java.lang.Boolean	getAllowEdit() Returns whether this Forum is allow edit.
java.lang.Boolean	getAllowForumGrading() Returns whether this Forum is allow forum grading.
java.lang.Boolean	getAllowForumSubscribe() Returns whether this Forum is allow subscribe.
java.lang.Boolean	getAllowMemberRate() Returns whether this Forum is allow rate.
java.lang.Boolean	getAllowMessageTagging() Returns whether tagging is enabled in this Forum.
java.lang.Boolean	getAllowQuote() Returns whether message quoting is allowed in this Forum.
java.lang.Boolean	getAllowSubscribe() Deprecated. use getAllowThreadSubscribe instead
java.lang.Boolean	getAllowThreadGrading() Returns whether this Forum is allow thread grading.
java.lang.Boolean	getAllowThreadSubscribe() Returns whether this Forum is allow subscribe.
java.lang.String	getAnonymousUser() Returns the key name for "Anonymous User"
DataType	getDataType() Returns the DataType identifier for this object.
java.lang.Boolean	getEnforceModeration() Returns whether this Forum is enforce moderation.
java.lang.String	getForumGradeLineitemPk() Returns forum grade handle value.
Id	getForumId() Returns the parent forum Id associated with this ForumProperties
float	getForumPointsPossible() Returns forum possible point.
java.lang.Boolean	getIncludeMessageInSubscription() Gets a flag indicating whether the entire message body should be included in the email sent to users who have subscribed to the forum or thread, or just a link.
void	setAllowAnonymous(java.lang.Boolean b) Sets whether this Forum is allow anonymous.
void	setAllowAttachemnt(java.lang.Boolean b) Sets whether this Forum is allow attachment.
void	setAllowCreate(java.lang.Boolean b) Sets whether this Forum is allow create.
void	setAllowDelete(java.lang.Boolean b) Sets whether this Forum is allow message delete.
void	setAllowDeleteTree(java.lang.Boolean b) Sets whether this Forum is allow message tree delete.
void	setAllowEdit(java.lang.Boolean b) Sets whether this Forum is allow edit.
void	setAllowForumGrading(java.lang.Boolean b) Sets whether this Forum is allow forum grading.
void	setAllowForumSubscribe(java.lang.Boolean b) Sets whether this Forum is allow subscribe.
void	setAllowMemberRate(java.lang.Boolean b) Sets whether this Forum is allow rate.
void	setAllowMessageTagging(java.lang.Boolean b) Sets whether tagging is enabled in this Forum.
void	setAllowQuote(java.lang.Boolean b) Sets whether this Forum allows message quoting.
void	setAllowSubscribe(java.lang.Boolean b) Deprecated. use setAllowThreadSubscribe instead
void	setAllowThreadGrading(java.lang.Boolean b) Sets whether this Forum is allow thread grading.
void	setAllowThreadSubscribe(java.lang.Boolean b) Sets whether this Forum is allow subscribe.
void	setAnonymousUser(java.lang.String annonymous_key) Sets the Allow Anonymous User property This will stored the key name for "Anonymous User" in the database
void	setEnforceModeration(java.lang.Boolean b) Sets whether this Forum is enforce moderation.
void	setForumGradeLineitemPk(java.lang.String pk) Sets forum grade handle value.
void	setForumId(Id forumId) Sets the forum Id value for this ForumProperties
void	setForumPointsPossible(float points) Sets forum possible point.
void	setIncludeMessageInSubscription(java.lang.Boolean includeMessage) Sets a flag indicating whether the entire message body should be included in the email sent to users who have subscribed to the forum or thread, or just a link.

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

ForumProperties

public ForumProperties()

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.

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

setAllowAnonymous

public void setAllowAnonymous(java.lang.Boolean b)

Sets whether this Forum is allow anonymous.

Parameters:

b - true if this forum is allow anonymous, false otherwise

getAllowAnonymous

public java.lang.Boolean getAllowAnonymous()

Returns whether this Forum is allow anonymous.

Returns:

true if this forum is allow anonymous, false otherwise

setAllowAttachemnt

public void setAllowAttachemnt(java.lang.Boolean b)

Sets whether this Forum is allow attachment.

Parameters:

b - true if this forum is allow attachment, false otherwise

getAllowAttachment

public java.lang.Boolean getAllowAttachment()

Returns whether this Forum is allow attachment.

Returns:

true if this forum is allow attachment, false otherwise

setAllowDelete

public void setAllowDelete(java.lang.Boolean b)

Sets whether this Forum is allow message delete.

Parameters:

b - true if this forum is allow message delete, false otherwise

getAllowDelete

public java.lang.Boolean getAllowDelete()

Returns whether this Forum is allow message delete.

Returns:

true if this forum is allow message delete, false otherwise

setAllowDeleteTree

public void setAllowDeleteTree(java.lang.Boolean b)

Sets whether this Forum is allow message tree delete.

Parameters:

b - true if this forum is allow message tree delete, false otherwise

getAllowDeleteTree

public java.lang.Boolean getAllowDeleteTree()

Returns whether this Forum is allow message tree delete.

Returns:

true if this forum is allow message tree delete, false otherwise

setAllowForumGrading

public void setAllowForumGrading(java.lang.Boolean b)

Sets whether this Forum is allow forum grading.

Parameters:

b - true if this forum is allow forum grading, false otherwise

getAllowForumGrading

public java.lang.Boolean getAllowForumGrading()

Returns whether this Forum is allow forum grading.

Returns:

true if this forum is allow forum grading, false otherwise

setAllowMessageTagging

public void setAllowMessageTagging(java.lang.Boolean b)

Sets whether tagging is enabled in this Forum.

Parameters:

b - true if tagging is enabled, false otherwise

getAllowMessageTagging

public java.lang.Boolean getAllowMessageTagging()

Returns whether tagging is enabled in this Forum.

Returns:

true if tagging is enabled, false otherwise

setAllowThreadGrading

public void setAllowThreadGrading(java.lang.Boolean b)

Sets whether this Forum is allow thread grading.

Parameters:

b - true if this forum is allow thread grading, false otherwise

getAllowThreadGrading

public java.lang.Boolean getAllowThreadGrading()

Returns whether this Forum is allow thread grading.

Returns:

true if this forum is allow thread grading, false otherwise

setEnforceModeration

public void setEnforceModeration(java.lang.Boolean b)

Sets whether this Forum is enforce moderation.

Parameters:

b - true if this forum is enforce moderation, false otherwise

getEnforceModeration

public java.lang.Boolean getEnforceModeration()

Returns whether this Forum is enforce moderation.

Returns:

true if this forum is enforce moderation, false otherwise

setAllowEdit

public void setAllowEdit(java.lang.Boolean b)

Sets whether this Forum is allow edit.

Parameters:

b - true if this forum is allow edit, false otherwise

getAllowEdit

public java.lang.Boolean getAllowEdit()

Returns whether this Forum is allow edit.

Returns:

true if this forum is allow edit, false otherwise

setAllowCreate

public void setAllowCreate(java.lang.Boolean b)

Sets whether this Forum is allow create.

Parameters:

b - true if this forum is allow create, false otherwise

getAllowCreate

public java.lang.Boolean getAllowCreate()

Returns whether this Forum is allow create.

Returns:

true if this forum is allow create, false otherwise

setAnonymousUser

public void setAnonymousUser(java.lang.String annonymous_key)

Sets the Allow Anonymous User property This will stored the key name for "Anonymous User" in the database

Parameters:

annonymous_key - key name for "Anonymous User"

getAnonymousUser

public java.lang.String getAnonymousUser()

Returns the key name for "Anonymous User"

Returns:

the Annonymous User key

setForumId

public void setForumId(Id forumId)

Sets the forum Id value for this ForumProperties

Parameters:

forumId - the forum Id value to use for this ForumProperties

getForumId

public Id getForumId()

Returns the parent forum Id associated with this ForumProperties

Returns:

forum Id value for this ForumProperties

setAllowThreadSubscribe

public void setAllowThreadSubscribe(java.lang.Boolean b)

Sets whether this Forum is allow subscribe.

Parameters:

b - true if this forum is allow subscribe, false otherwise

getAllowThreadSubscribe

public java.lang.Boolean getAllowThreadSubscribe()

Returns whether this Forum is allow subscribe.

Returns:

true if this forum is allow subscribe, false otherwise

setAllowForumSubscribe

public void setAllowForumSubscribe(java.lang.Boolean b)

Sets whether this Forum is allow subscribe.

Parameters:

b - true if this forum is allow subscribe, false otherwise

getAllowForumSubscribe

public java.lang.Boolean getAllowForumSubscribe()

Returns whether this Forum is allow subscribe.

Returns:

true if this forum is allow subscribe, false otherwise

setIncludeMessageInSubscription

public void setIncludeMessageInSubscription(java.lang.Boolean includeMessage)

Sets a flag indicating whether the entire message body should be included in the email sent to users who have subscribed to the forum or thread, or just a link.

Parameters:

includeMessage - set Boolean to true to include the full message in the email

Since:

7.3

getIncludeMessageInSubscription

public java.lang.Boolean getIncludeMessageInSubscription()

Gets a flag indicating whether the entire message body should be included in the email sent to users who have subscribed to the forum or thread, or just a link.

Returns:

includeMessage get Boolean true to indicate include the full message in the email

Since:

7.3

setAllowSubscribe

public void setAllowSubscribe(java.lang.Boolean b)

Deprecated. use setAllowThreadSubscribe instead

Sets whether this Forum allows thread subscriptions.

Parameters:

b - true if this forum is allow subscribe, false otherwise

getAllowSubscribe

public java.lang.Boolean getAllowSubscribe()

Deprecated. use getAllowThreadSubscribe instead

Returns whether this Forum allows thread subscriptions.

Returns:

true if this forum is allow subscribe, false otherwise

setAllowMemberRate

public void setAllowMemberRate(java.lang.Boolean b)

Sets whether this Forum is allow rate.

Parameters:

b - true if this forum is allow rate, false otherwise

getAllowMemberRate

public java.lang.Boolean getAllowMemberRate()

Returns whether this Forum is allow rate.

Returns:

true if this forum is allow rate, false otherwise

setAllowQuote

public void setAllowQuote(java.lang.Boolean b)

Sets whether this Forum allows message quoting.

Parameters:

b - true if this forum allows quoting, false otherwise

getAllowQuote

public java.lang.Boolean getAllowQuote()

Returns whether message quoting is allowed in this Forum.

Returns:

true if quoting is allowed, false otherwise

getForumGradeLineitemPk

public java.lang.String getForumGradeLineitemPk()

Returns forum grade handle value.

Returns:

forum grade handle value

setForumGradeLineitemPk

public void setForumGradeLineitemPk(java.lang.String pk)

Sets forum grade handle value.

Parameters:

pk - forum grade handle value

getForumPointsPossible

public float getForumPointsPossible()

Returns forum possible point.

Returns:

forum possible point

setForumPointsPossible

public void setForumPointsPossible(float points)

Sets forum possible point.

Parameters:

points - forum possible point