blackboard.data.discussionboard
Class MessageLabel

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

All Implemented Interfaces:

IBbObject, Identifiable, java.lang.Cloneable

public class MessageLabel
extends BbObject

The MessageLabel class represents a label to a given discussion board message within the Bb Course Management System.

Version:

$Revision: #1 $ 2005-4-18 $

Field Summary

static DataType

DATA_TYPE

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

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

Method Summary

static ListFilter	createMessageIdFilter(Id parentMsgId) Factory method to create an instance of the ListFilter interface capable of filtering a list of MessageLabel objects based upon their parent message's Id value.
DataType	getDataType() Returns the DataType identifier for this object.
java.lang.String	getLabel() Returns the label that this MessageLabel represents.
Id	getParentMsgId() Returns the parent message Id associated with this MessageLabel.
void	setLabel(java.lang.String label) Sets the label that this MessageLabel should represent.
void	setParentMsgId(Id iParentMsgId) Sets the parent message Id associated with this MessageLabel.

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

Constructor Detail

MessageLabel

public MessageLabel()

Creates an instance of MessageLabel with default property values.

Method Detail

getParentMsgId

public Id getParentMsgId()

Returns the parent message Id associated with this MessageLabel.

Returns:

parent message Id value for this message label

setParentMsgId

public void setParentMsgId(Id iParentMsgId)

Sets the parent message Id associated with this MessageLabel.

Parameters:

iParentMsgId - the parent message Id value to use for this message label

getLabel

public java.lang.String getLabel()

Returns the label that this MessageLabel represents.

Returns:

the label this MessageLabel represents as a String

setLabel

public void setLabel(java.lang.String label)

Sets the label that this MessageLabel should represent.

Parameters:

label - the lacel that this MessageLabel should represent

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

createMessageIdFilter

public static final ListFilter createMessageIdFilter(Id parentMsgId)

Factory method to create an instance of the ListFilter interface capable of filtering a list of MessageLabel objects based upon their parent message's Id value. Should be used with BbList.Iterator.

Parameters:

parentId - the Id of the parent for which message label should be returned. Message label that is attached to a given message (identified by Id) will be returned.

Returns:

a ListFilter instance that can filter on parent Id