blackboard.data.discussionboard
Class UserMsgState

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

All Implemented Interfaces:

IBbObject, Identifiable, java.lang.Cloneable

public class UserMsgState
extends BbObject

Since:

Bb 7.0

Version:

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

Field Summary

static DataType

DATA_TYPE

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

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

Method Summary

DataType	getDataType() Returns the DataType identifier for this object.
java.lang.String	getImportantInd() Returns important ind for this message.
Id	getMsgMainId() Returns the Msg_Main Id to which this UserMsgState was posted.
int	getMsgReadCount() Returns a number of the times this message has been accessed (viewed).
int	getRating() Return rating of this message.
boolean	getReadState() Return mark read state of this message.
java.lang.String	getSubscribedInd() Returns subscribed ind for this message .
User	getUser() Returns the user associated with this UserMsgState
Id	getUserId() Returns the user Id associated with this UserMsgState.
void	setImportantInd(java.lang.String importantInd) Sets the important ind for this message.
void	setMsgMainId(Id iMsgMainId) Sets the Msg_Main Id value for this UserMsgState
void	setMsgReadCount(int nHitCount) Sets the number of times this message has been accessed.
void	setRating(int rating) Sets the rating for this message.
void	setReadState(boolean readState) Sets the mark read state for this message.
void	setSubscribedInd(java.lang.String subscribedInd) Sets the subscribed ind for this message.
void	setUser(User user) Sets the user information for this UserMsgState
void	setUserId(Id iUserId) Sets the user Id value for this UserMsgState
void	validate() Validates the contents of this UserMsgState.

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

UserMsgState

public UserMsgState()

Creates an instance of UserMsgState 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 UserMsgState. This value is the id of the user who posted/owns the message.

Returns:

user Id value for this UserMsgState

setUserId

public void setUserId(Id iUserId)

Sets the user Id value for this UserMsgState

Parameters:

iUserId - the user Id value to use for this UserMsgState

getMsgMainId

public Id getMsgMainId()

Returns the Msg_Main Id to which this UserMsgState was posted.

Returns:

Msg_Main Id value for this UserMsgState

setMsgMainId

public void setMsgMainId(Id iMsgMainId)

Sets the Msg_Main Id value for this UserMsgState

Parameters:

iMsgMainId - the Msg_Main Id value to use for this UserMsgState

getMsgReadCount

public int getMsgReadCount()

Returns a number of the times this message has been accessed (viewed).

Returns:

an int representing the number of times this message has been accessed

setMsgReadCount

public void setMsgReadCount(int nHitCount)

Sets the number of times this message has been accessed.

Parameters:

nHitCount - an int representing the number of times this message has been accessed

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

getImportantInd

public java.lang.String getImportantInd()

Returns important ind for this message.

Returns:

a String value for the important ind of this message

setImportantInd

public void setImportantInd(java.lang.String importantInd)

Sets the important ind for this message.

Parameters:

importantInd - an string point out the important ind.

getRating

public int getRating()

Return rating of this message.

Returns:

a int number

setRating

public void setRating(int rating)

Sets the rating for this message.

Parameters:

rating - a number, rating for this message.

getReadState

public boolean getReadState()

Return mark read state of this message.

Returns:

a boolean number

setReadState

public void setReadState(boolean readState)

Sets the mark read state for this message.

Parameters:

readState - a boolean, mark read state for this message.

setUser

public void setUser(User user)

Sets the user information for this UserMsgState

Parameters:

user - the user

getUser

public User getUser()

Returns the user associated with this UserMsgState

Returns:

the user associated with this UserMsgState

validate

public void validate()
              throws ValidationException

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