blackboard.data.discussionboard
Class UserForumSettings

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

All Implemented Interfaces:

IBbObject, Identifiable, java.lang.Cloneable

public class UserForumSettings
extends BbObject

The UserForumSettings class is a representation of the discussion board forum settings.

Since:

Bb 6.3

Version:

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

Nested Class Summary

static class

UserForumSettings.ForumRole Enumeration for reflecting user forum role A normal user will have a null value in the role A blocked user will be a READER A moderator will be a MODERATOR We can add additioal roles in this later

Field Summary

static DataType

DATA_TYPE

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

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

Method Summary

boolean	getAdminInd() Returns the flag denoting if the associated user account is Manager of the active discussion board forum.
java.lang.String	getAlias() Returns the alias associated with this UserForumSettings
DataType	getDataType() Returns the DataType identifier for this object.
java.util.Calendar	getDtLastVisit() Returns the last visit date associated with this UserForumSettings
Id	getForumId() Returns the Forum Id associated with this UserForumSettings.
UserForumSettings.ForumRole	getForumRole() Returns the ForumRole associated with this UserForumSettings
boolean	getIsLockedOut() Returns the flag denoting if the associated user account is blocked from accessing the active discussion board forum.
java.lang.String	getMessageSort() This field is not in active use and should not be used.
java.lang.String	getSearchSort() This field is not in active use and should not be used.
java.lang.String	getSubscribedInd() Returns subscribed ind for this message .
User	getUser() Returns the user associated with this UserForumSettings
Id	getUserId() Returns the user Id associated with this UserForumSettings.
void	setAdminInd(boolean val) Sets the flag denoting if the associated user account is Manager of the active discussion board forum.
void	setAlias(java.lang.String val) Sets the alias for this UserForumSettings
void	setDtLastVisit(java.util.Calendar val) Sets the last visit date for this UserForumSettings
void	setForumId(Id id) Sets the Forum Id value for this UserForumSettings.
void	setForumRole(UserForumSettings.ForumRole val) Sets the ForumRole for this UserForumSettings
void	setIsLockedOut(boolean val) Sets the flag denoting if the associated user account is blocked from accessing the active discussion board forum.
void	setMessageSort(java.lang.String val) This field is not in active use and should not be used.
void	setSearchSort(java.lang.String val) This field is not in active use and should not be used.
void	setSubscribedInd(java.lang.String subscribedInd) Sets the subscribed ind for this message.
void	setUser(User user) Sets the user information for this UserForumSettings
void	setUserId(Id id) Sets the user Id value for this UserForumSettings.
void	setUserInfo(User user) Deprecated. use setUser instead
void	validate() Validates the contents of this UserForumSettings.

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

UserForumSettings

public UserForumSettings()

Creates an instance of UserForumSettings with default property values.

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

getUserId

public Id getUserId()

Returns the user Id associated with this UserForumSettings.

Returns:

user Id value for this UserForumSettings

setUserId

public void setUserId(Id id)

Sets the user Id value for this UserForumSettings.

Parameters:

id - the user Id value to use for this UserForumSettings

getMessageSort

public java.lang.String getMessageSort()

This field is not in active use and should not be used.

setMessageSort

public void setMessageSort(java.lang.String val)

This field is not in active use and should not be used.

getSearchSort

public java.lang.String getSearchSort()

This field is not in active use and should not be used.

setSearchSort

public void setSearchSort(java.lang.String val)

This field is not in active use and should not be used.

getForumId

public Id getForumId()

Returns the Forum Id associated with this UserForumSettings.

Returns:

Forum Id value for this UserForumSettings

setForumId

public void setForumId(Id id)

Sets the Forum Id value for this UserForumSettings.

Parameters:

id - the Forum Id value to use for this UserForumSettings

getIsLockedOut

public boolean getIsLockedOut()

Returns the flag denoting if the associated user account is blocked from accessing the active discussion board forum.

Returns:

true if blocked, false otherwise

setIsLockedOut

public void setIsLockedOut(boolean val)

Sets the flag denoting if the associated user account is blocked from accessing the active discussion board forum.

Parameters:

val - true if blocked, false otherwise

getAdminInd

public boolean getAdminInd()

Returns the flag denoting if the associated user account is Manager of the active discussion board forum.

Returns:

true if is manager, false otherwise

setAdminInd

public void setAdminInd(boolean val)

Sets the flag denoting if the associated user account is Manager of the active discussion board forum.

Parameters:

val - true if is manager, false otherwise

getAlias

public java.lang.String getAlias()

Returns the alias associated with this UserForumSettings

Returns:

the alias associated with this UserForumSettings

setAlias

public void setAlias(java.lang.String val)

Sets the alias for this UserForumSettings

Parameters:

val - the alias

getForumRole

public UserForumSettings.ForumRole getForumRole()

Returns the ForumRole associated with this UserForumSettings

Returns:

the ForumRole associated with this UserForumSettings

setForumRole

public void setForumRole(UserForumSettings.ForumRole val)

Sets the ForumRole for this UserForumSettings

Parameters:

val - the ForumRole

getDtLastVisit

public java.util.Calendar getDtLastVisit()

Returns the last visit date associated with this UserForumSettings

Returns:

the last visit date associated with this UserForumSettings

setDtLastVisit

public void setDtLastVisit(java.util.Calendar val)

Sets the last visit date for this UserForumSettings

Parameters:

val - the last visit date

setUserInfo

public void setUserInfo(User user)

Deprecated. use setUser instead

Sets the user information for this UserForumSettings

Parameters:

user - the user

setUser

public void setUser(User user)

Sets the user information for this UserForumSettings

Parameters:

user - the user

getUser

public User getUser()

Returns the user associated with this UserForumSettings

Returns:

the user associated with this UserForumSettings

getSubscribedInd

public java.lang.String getSubscribedInd()

Returns subscribed ind for this message .

Returns:

a String value for subscribed ind of this message

setSubscribedInd

public void setSubscribedInd(java.lang.String subscribedInd)

Sets the subscribed ind for this message.

Parameters:

subscribedInd - a Y/N indicator of whether this user is subscribed to this message

validate

public void validate()
              throws ValidationException

Validates the contents of this UserForumSettings. 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