com.appiancorp.suiteapi.forums

Class ThreadedMessage

java.lang.Object

com.appiancorp.suiteapi.forums.ThreadedMessage

Deprecated.

The Discussion Forums functionality will be removed in a future release. Use the News feed and related smart services to build applications with similar functionality.

@Deprecated
public class ThreadedMessage
extends java.lang.Object

A convenience class that gathers the information required by clients to display a list of threads and their contained messages.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	SORT_BY_ANONYMOUS_AUTHOR Deprecated.
static java.lang.Integer	SORT_BY_AUTHOR Deprecated.
static java.lang.Integer	SORT_BY_AVERAGE_RATING Deprecated.
static java.lang.Integer	SORT_BY_BODY_LOCATION Deprecated.
static java.lang.Integer	SORT_BY_DATE_POSTED Deprecated.
static java.lang.Integer	SORT_BY_DEPTH Deprecated.
static java.lang.Integer	SORT_BY_RATING_COUNT Deprecated.
static java.lang.Integer	SORT_BY_SPONSORED Deprecated.
static java.lang.Integer	SORT_BY_SUBJECT Deprecated.

Constructor Summary

Constructors

Constructor and Description
ThreadedMessage() Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer[]	getAllowedForumActions() Deprecated. Get the actions that the user can do on this forum.
java.lang.Integer[]	getAllowedMessageActions() Deprecated. Get the actions that the user can do on this message.
java.lang.Integer[]	getAllowedThreadActions() Deprecated. Get the actions that the user can do on this thread.
java.lang.String	getAuthor() Deprecated. Get the user name of the message's author.
double	getAverageRating() Deprecated. Get the rating of this message.
java.lang.String	getBody() Deprecated. Get the body for this message.
java.lang.String	getBodyLocation() Deprecated. Set the location of this body.
java.sql.Timestamp	getDatePosted() Deprecated. Get the date-time this message was posted.
int	getDepth() Deprecated. Get the depth of the message.
GlobalId	getForumId() Deprecated. Get the GlobalId for the forum containing the message.
GlobalId	getMessageId() Deprecated. Get the GlobalId of the message.
GlobalId	getParentId() Deprecated. Get the GlobalId of the message's parent message.
int	getRatingCount() Deprecated. Get the count of ratings for this message.
java.lang.String	getSubject() Deprecated. Get the subject of this message.
GlobalId	getThreadId() Deprecated. Get the GlobalId for the thread containing this message.
boolean	isAnonymousAuthor() Deprecated. Determine if the author of the message is anonymous.
boolean	isSponsored() Deprecated. Determine whether this thread is sponsored.
void	setAllowedForumActions(java.lang.Integer[] allowedForumActions_) Deprecated. Set the actions that the user can do on this forum.
void	setAllowedMessageActions(java.lang.Integer[] allowedMessageActions_) Deprecated. Set the actions that the user can do on this message.
void	setAllowedThreadActions(java.lang.Integer[] allowedThreadActions_) Deprecated. Set the actions that the user can do on this thread.
void	setAnonymousAuthor(boolean anonymous_) Deprecated. Set whether the author of this message is anonymous.
void	setAuthor(java.lang.String author_) Deprecated. Set the user name of the message's author.
void	setAverageRating(double rating_) Deprecated. Set the rating of this message.
void	setBody(java.lang.String body_) Deprecated. Set the body for this message.
void	setBodyLocation(java.lang.String filename_) Deprecated. Get the location of this body.
void	setDatePosted(java.sql.Timestamp time_) Deprecated. Set the date-time this message was posted.
void	setDepth(int depth_) Deprecated. Set the depth of the message.
void	setForumId(GlobalId forumId_) Deprecated. Set the GlobalId for the forum containing the message.
void	setMessageId(GlobalId messageId_) Deprecated. Set the GlobalId of the message.
void	setParentId(GlobalId parentId_) Deprecated. Set the GlobalId of the message's parent message.
void	setRatingCount(int ratingCount_) Deprecated. Set the count of ratings for this message.
void	setSponsored(boolean sponsored_) Deprecated. Set whether this thread is sponsored.
void	setSubject(java.lang.String subject_) Deprecated. Set the subject of this message.
void	setThreadId(GlobalId threadId_) Deprecated. Set the GlobalId for the thread containing this message.

Methods inherited from class java.lang.Object

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

Field Detail

SORT_BY_DEPTH

public static final java.lang.Integer SORT_BY_DEPTH

Deprecated.

SORT_BY_AUTHOR

public static final java.lang.Integer SORT_BY_AUTHOR

Deprecated.

SORT_BY_ANONYMOUS_AUTHOR

public static final java.lang.Integer SORT_BY_ANONYMOUS_AUTHOR

Deprecated.

SORT_BY_DATE_POSTED

public static final java.lang.Integer SORT_BY_DATE_POSTED

Deprecated.

SORT_BY_SUBJECT

public static final java.lang.Integer SORT_BY_SUBJECT

Deprecated.

SORT_BY_AVERAGE_RATING

public static final java.lang.Integer SORT_BY_AVERAGE_RATING

Deprecated.

SORT_BY_RATING_COUNT

public static final java.lang.Integer SORT_BY_RATING_COUNT

Deprecated.

SORT_BY_BODY_LOCATION

public static final java.lang.Integer SORT_BY_BODY_LOCATION

Deprecated.

SORT_BY_SPONSORED

public static final java.lang.Integer SORT_BY_SPONSORED

Deprecated.

Constructor Detail

ThreadedMessage

public ThreadedMessage()

Deprecated.

Method Detail

getMessageId

public GlobalId getMessageId()

Deprecated.

Get the GlobalId of the message.

Returns:

The GlobalId.

setMessageId

public void setMessageId(GlobalId messageId_)

Deprecated.

Set the GlobalId of the message.

Parameters:

messageId_ -

getParentId

public GlobalId getParentId()

Deprecated.

Get the GlobalId of the message's parent message.

Returns:

The parent's GlobalId.

setParentId

public void setParentId(GlobalId parentId_)

Deprecated.

Set the GlobalId of the message's parent message.

Parameters:

parentId_ -

getDepth

public int getDepth()

Deprecated.

Get the depth of the message. See Message for a definition of depth.

Returns:

The depth.

setDepth

public void setDepth(int depth_)

Deprecated.

Set the depth of the message. See Message for a definition of depth.

Parameters:

depth_ -

getAuthor

public java.lang.String getAuthor()

Deprecated.

Get the user name of the message's author.

Returns:

The author's user name.

setAuthor

public void setAuthor(java.lang.String author_)

Deprecated.

Set the user name of the message's author.

Parameters:

author_ - the author to set

isAnonymousAuthor

public boolean isAnonymousAuthor()

Deprecated.

Determine if the author of the message is anonymous.

Returns:

true if the author is anonymous; false otherwise.

setAnonymousAuthor

public void setAnonymousAuthor(boolean anonymous_)

Deprecated.

Set whether the author of this message is anonymous.

Parameters:

anonymous_ -

getDatePosted

public java.sql.Timestamp getDatePosted()

Deprecated.

Get the date-time this message was posted.

Returns:

The date-time.

setDatePosted

public void setDatePosted(java.sql.Timestamp time_)

Deprecated.

Set the date-time this message was posted.

Parameters:

time_ -

getSubject

public java.lang.String getSubject()

Deprecated.

Get the subject of this message.

Returns:

The subject.

setSubject

public void setSubject(java.lang.String subject_)

Deprecated.

Set the subject of this message.

Parameters:

subject_ -

getBody

public java.lang.String getBody()

Deprecated.

Get the body for this message.

Returns:

The body.

setBody

public void setBody(java.lang.String body_)

Deprecated.

Set the body for this message.

Parameters:

body_ -

getAverageRating

public double getAverageRating()

Deprecated.

Get the rating of this message.

Returns:

The rating.

setAverageRating

public void setAverageRating(double rating_)

Deprecated.

Set the rating of this message.

Parameters:

rating_ -

getRatingCount

public int getRatingCount()

Deprecated.

Get the count of ratings for this message.

Returns:

The number of ratings.

setRatingCount

public void setRatingCount(int ratingCount_)

Deprecated.

Set the count of ratings for this message.

Parameters:

ratingCount_ -

getBodyLocation

public java.lang.String getBodyLocation()

Deprecated.

Set the location of this body. See Message.

Returns:

The body's location.

setBodyLocation

public void setBodyLocation(java.lang.String filename_)

Deprecated.

Get the location of this body. See Message.

Parameters:

filename_ -

getThreadId

public GlobalId getThreadId()

Deprecated.

Get the GlobalId for the thread containing this message.

Returns:

The thread's GlobalId.

setThreadId

public void setThreadId(GlobalId threadId_)

Deprecated.

Set the GlobalId for the thread containing this message.

Parameters:

threadId_ -

isSponsored

public boolean isSponsored()

Deprecated.

Determine whether this thread is sponsored.

Returns:

true if this thread is sponsored; false otherwise.

setSponsored

public void setSponsored(boolean sponsored_)

Deprecated.

Set whether this thread is sponsored.

Parameters:

sponsored_ -

getForumId

public GlobalId getForumId()

Deprecated.

Get the GlobalId for the forum containing the message.

Returns:

The forum GlobalId.

setForumId

public void setForumId(GlobalId forumId_)

Deprecated.

Set the GlobalId for the forum containing the message.

Parameters:

forumId_ -

getAllowedForumActions

public java.lang.Integer[] getAllowedForumActions()

Deprecated.

Get the actions that the user can do on this forum.

Returns:

An array of the actions.

setAllowedForumActions

public void setAllowedForumActions(java.lang.Integer[] allowedForumActions_)

Deprecated.

Set the actions that the user can do on this forum.

Parameters:

allowedForumActions_ - An array of the actions.

getAllowedMessageActions

public java.lang.Integer[] getAllowedMessageActions()

Deprecated.

Get the actions that the user can do on this message.

Returns:

An array of the actions.

setAllowedMessageActions

public void setAllowedMessageActions(java.lang.Integer[] allowedMessageActions_)

Deprecated.

Set the actions that the user can do on this message.

Parameters:

allowedMessageActions_ - An array of the actions.

getAllowedThreadActions

public java.lang.Integer[] getAllowedThreadActions()

Deprecated.

Get the actions that the user can do on this thread.

Returns:

An array of the actions.

setAllowedThreadActions

public void setAllowedThreadActions(java.lang.Integer[] allowedThreadActions_)

Deprecated.

Set the actions that the user can do on this thread.

Parameters:

allowedThreadActions_ - An array of the actions.