oracle.workspaces.resource.discussion
Class CwMessageDefinition

java.lang.Object
oracle.workspaces.resource.CwResourceItemDefinition
oracle.workspaces.resource.discussion.CwMessageDefinition

public class CwMessageDefinition

extends CwResourceItemDefinition

Definition class used to create a CwMessage. Create the CwMessageDefinition, fill in all appropriate properties, and then call cwBoard.createMessage() to post the message to the board.

Since:

release specific (what release of product did this appear in)

Constructor Summary

CwMessageDefinition()
Constructor for a message definition object representing the first message of a new thread.

CwMessageDefinition(CwMessage messageRepliedTo)
Constructor for a message definition object representing a reply to a message in an existing thread.

CwMessageDefinition(CwMessage messageRepliedTo, java.util.Locale locale, java.util.TimeZone tz)
Constructor for a message definition object representing a reply to a message in an existing thread.

Method Summary

java.lang.String	getContentType() Returns the content type of the message, null if not set.
java.lang.String	getDescription() A CwMessage resource item does not have the concept of a "description"; therefore this method throws UnsupportedOperationException.
java.lang.String	getName() A CwMessage resource item does not have the concept of a "name"; therefore this method throws UnsupportedOperationException.
java.lang.String	getSubject() Returns the subject of the message, null if not set.
java.lang.String	getText() Returns the text of the message, null if not set.
boolean	isReply() Returns a boolean which indicates whether this message definition represents a reply to an existing message.
void	setContentType(java.lang.String contentType) Set the content type of the message to the specified type.
void	setDescription(java.lang.String szDescription) A CwMessage resource item does not have the concept of a "description"; therefore this method throws UnsupportedOperationException.
void	setName(java.lang.String szName) A CwMessage resource item does not have the concept of a "name"; therefore this method throws UnsupportedOperationException.
void	setSubject(java.lang.String szSubject) Set the subject of the message to the specified String.
void	setText(java.lang.String szText) Set the text of the message to the specified String.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CwMessageDefinition

public CwMessageDefinition()
                    throws CwException

Constructor for a message definition object representing the first message of a new thread. Note that none of the message definition properties are required, so they are all set via accessor methods.

CwMessageDefinition

public CwMessageDefinition(CwMessage messageRepliedTo)
                    throws CwException

Constructor for a message definition object representing a reply to a message in an existing thread. Note that none of the basic message definition properties are required, so they are all set via accessor methods.

Parameters:

messageRepliedTo - the message being replied to by this new message; if null, indicates no original message and a new thread message is created.

CwMessageDefinition

public CwMessageDefinition(CwMessage messageRepliedTo,
                           java.util.Locale locale,
                           java.util.TimeZone tz)
                    throws CwException

Constructor for a message definition object representing a reply to a message in an existing thread. Note that none of the basic message definition properties are required, so they are all set via accessor methods.

Parameters:

messageRepliedTo - the message being replied to by this new message; if null, indicates no original message and a new thread message is created.

locale - the client locale.

tz - the client timezone.

Method Detail

getContentType

public java.lang.String getContentType()

Returns the content type of the message, null if not set.

getDescription

public java.lang.String getDescription()

A CwMessage resource item does not have the concept of a "description"; therefore this method throws UnsupportedOperationException.

Overrides:

getDescription in class CwResourceItemDefinition

Returns:

the resource item description

getName

public java.lang.String getName()

A CwMessage resource item does not have the concept of a "name"; therefore this method throws UnsupportedOperationException.

Overrides:

getName in class CwResourceItemDefinition

Returns:

the resource item name

getSubject

public java.lang.String getSubject()

Returns the subject of the message, null if not set.

getText

public java.lang.String getText()

Returns the text of the message, null if not set.

isReply

public boolean isReply()

Returns a boolean which indicates whether this message definition represents a reply to an existing message.

setContentType

public void setContentType(java.lang.String contentType)

Set the content type of the message to the specified type.

setDescription

public void setDescription(java.lang.String szDescription)

A CwMessage resource item does not have the concept of a "description"; therefore this method throws UnsupportedOperationException.

Overrides:

setDescription in class CwResourceItemDefinition

setName

public void setName(java.lang.String szName)

A CwMessage resource item does not have the concept of a "name"; therefore this method throws UnsupportedOperationException.

Overrides:

setName in class CwResourceItemDefinition

setSubject

public void setSubject(java.lang.String szSubject)

Set the subject of the message to the specified String.

setText

public void setText(java.lang.String szText)

Set the text of the message to the specified String.