com.appiancorp.suiteapi.forums

Class Message

java.lang.Object

com.appiancorp.suiteapi.forums.Message

All Implemented Interfaces:

GlobalId, LocalId, java.io.Serializable

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.

@DiscussionMessageDataType
 @Deprecated
public class Message
extends java.lang.Object
implements GlobalId

A single message within a discussion.

See Also:

Serialized Form

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_ID Deprecated.
static java.lang.Integer	SORT_BY_PARENT_ID Deprecated.
static java.lang.Integer	SORT_BY_RATING_COUNT Deprecated.
static java.lang.Integer	SORT_BY_SUBJECT Deprecated.
static java.lang.Integer	SORT_BY_THREAD_ID Deprecated.

Constructor Summary

Constructors

Constructor and Description
Message() Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.Integer[]	getAllowedActions() Deprecated. Get the actions that the user can do on this object.
java.lang.String	getAuthor() Deprecated. Get the user name of the author of this message.
double	getAverageRating() Deprecated. Get the rating of this message.
java.lang.String	getBody() Deprecated. Get the body of this message.
java.lang.String	getBodyLocation() Deprecated. Get the location of the body.
java.sql.Timestamp	getDatePosted() Deprecated. Get the date-time this message was posted.
int	getDepth() Deprecated. Get the depth of this message.
java.lang.Long	getId() Deprecated. Returns this object's local identifier, null if the object was not identified locally using a Long Id.
java.lang.Long	getParentId() Deprecated. Get the local id of the message that is the parent to this message.
int	getRatingCount() Deprecated. Get the count of ratings that have been submitted for this messaage.
RemoteId	getRemoteId() Deprecated. Returns the RemoteId of this object's instance identifier, null if the object is only locally identified.
java.lang.String	getSubject() Deprecated. Get the subject for this message.
java.lang.Long	getThreadId() Deprecated. Get the local id of the thread which contains this message.
boolean	isAnonymousAuthor() Deprecated. Determine if the author of this message is anonymous.
void	setAllowedActions(java.lang.Integer[] allowedActions_) Deprecated. Set the actions that the user can do on this object.
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 author of this message.
void	setAverageRating(double averageRating_) Deprecated. Set the rating of this message.
void	setBody(java.lang.String body_) Deprecated. Set the body of this message.
void	setBodyLocation(java.lang.String filename_) Deprecated. Set the location of the 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 this message.
void	setId(java.lang.Long id_) Deprecated. Sets this object's local identifier.
void	setParentId(java.lang.Long parentId_) Deprecated. Set the local id of the message that is the parent to this message.
void	setRatingCount(int ratingCount_) Deprecated. Set the count of ratings that have been submitted for this messaage.
void	setRemoteId(RemoteId remoteId_) Deprecated. Sets this object's remote identifier.
void	setSubject(java.lang.String subject_) Deprecated. Set the subject for this message.
void	setThreadId(java.lang.Long threadId_) Deprecated. Set the local id of the thread which contains this message.

Methods inherited from class java.lang.Object

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

Field Detail

SORT_BY_ID

public static final java.lang.Integer SORT_BY_ID

Deprecated.

SORT_BY_PARENT_ID

public static final java.lang.Integer SORT_BY_PARENT_ID

Deprecated.

SORT_BY_AUTHOR

public static final java.lang.Integer SORT_BY_AUTHOR

Deprecated.

SORT_BY_DATE_POSTED

public static final java.lang.Integer SORT_BY_DATE_POSTED

Deprecated.

SORT_BY_THREAD_ID

public static final java.lang.Integer SORT_BY_THREAD_ID

Deprecated.

SORT_BY_SUBJECT

public static final java.lang.Integer SORT_BY_SUBJECT

Deprecated.

SORT_BY_BODY_LOCATION

public static final java.lang.Integer SORT_BY_BODY_LOCATION

Deprecated.

SORT_BY_DEPTH

public static final java.lang.Integer SORT_BY_DEPTH

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_ANONYMOUS_AUTHOR

public static final java.lang.Integer SORT_BY_ANONYMOUS_AUTHOR

Deprecated.

Constructor Detail

Message

public Message()

Deprecated.

Method Detail

isAnonymousAuthor

public boolean isAnonymousAuthor()

Deprecated.

Determine if the author of this message is anonymous.

Returns:

true if anonymous, false if not.

setAnonymousAuthor

public void setAnonymousAuthor(boolean anonymous_)

Deprecated.

Set whether the author of this message is anonymous.

Parameters:

anonymous_ -

getAuthor

public java.lang.String getAuthor()

Deprecated.

Get the user name of the author of this message.

Returns:

The user name

setAuthor

public void setAuthor(java.lang.String author_)

Deprecated.

Set the user name of the author of this message.

Parameters:

author_ - The user name

getAverageRating

public double getAverageRating()

Deprecated.

Get the rating of this message.

Returns:

The rating.

setAverageRating

public void setAverageRating(double averageRating_)

Deprecated.

Set the rating of this message.

Parameters:

averageRating_ - The rating.

getBody

public java.lang.String getBody()

Deprecated.

Get the body of this message.

Returns:

The body.

setBody

public void setBody(java.lang.String body_)

Deprecated.

Set the body of this message.

Parameters:

body_ - The body.

getDatePosted

public java.sql.Timestamp getDatePosted()

Deprecated.

Get the date-time this message was posted.

Returns:

The timestamp.

setDatePosted

public void setDatePosted(java.sql.Timestamp time_)

Deprecated.

Set the date-time this message was posted.

Parameters:

time_ - The timestamp

getDepth

public int getDepth()

Deprecated.

Get the depth of this message. The depth is the number of messages above this message in the reply sequence. The depth of the root message in a thread is zero. The depth of direct replies to the root message is one. The depth of replies to direct replies to the root message is two.

Returns:

The depth.

setDepth

public void setDepth(int depth_)

Deprecated.

Set the depth of this message. The depth is the number of messages above this message in the reply sequence. The depth of the root message in a thread is zero. The depth of direct replies to the root message is one. The depth of replies to direct replies to the root message is two.

Parameters:

depth_ - The depth.

getBodyLocation

public java.lang.String getBodyLocation()

Deprecated.

Get the location of the body. The location should not be used by clients and may change without warning.

Returns:

The lcoation.

setBodyLocation

public void setBodyLocation(java.lang.String filename_)

Deprecated.

Set the location of the body. The location should not be used by clients and may change without warning.

Parameters:

filename_ - The location.

getId

public java.lang.Long getId()

Deprecated.

Description copied from interface: LocalId

Returns this object's local identifier, null if the object was not identified locally using a Long Id.

Specified by:

getId in interface LocalId

Returns:

Object's Id

See Also:

LocalId.setId(Long)

setId

public void setId(java.lang.Long id_)

Deprecated.

Description copied from interface: LocalId

Sets this object's local identifier.

Specified by:

setId in interface LocalId

Parameters:

id_ - Id to set

See Also:

LocalId.getId()

getParentId

public java.lang.Long getParentId()

Deprecated.

Get the local id of the message that is the parent to this message. A zero indicates that this is a root message.

Returns:

The message local id.

setParentId

public void setParentId(java.lang.Long parentId_)

Deprecated.

Set the local id of the message that is the parent to this message. A zero indicates that this is a root message.

Parameters:

parentId_ - The message local id.

getRatingCount

public int getRatingCount()

Deprecated.

Get the count of ratings that have been submitted for this messaage.

Returns:

The count.

setRatingCount

public void setRatingCount(int ratingCount_)

Deprecated.

Set the count of ratings that have been submitted for this messaage.

Parameters:

ratingCount_ - The count.

getRemoteId

public RemoteId getRemoteId()

Deprecated.

Description copied from interface: GlobalId

Returns the RemoteId of this object's instance identifier, null if the object is only locally identified.

Specified by:

getRemoteId in interface GlobalId

Returns:

Object's remote Id.

See Also:

GlobalId.setRemoteId(RemoteId)

setRemoteId

public void setRemoteId(RemoteId remoteId_)

Deprecated.

Description copied from interface: GlobalId

Sets this object's remote identifier.

Specified by:

setRemoteId in interface GlobalId

Parameters:

remoteId_ - remove Id to set

See Also:

GlobalId.getRemoteId()

getSubject

public java.lang.String getSubject()

Deprecated.

Get the subject for this message.

Returns:

The subject.

setSubject

public void setSubject(java.lang.String subject_)

Deprecated.

Set the subject for this message.

Parameters:

subject_ - The subject.

getThreadId

public java.lang.Long getThreadId()

Deprecated.

Get the local id of the thread which contains this message.

Returns:

The thread local id.

setThreadId

public void setThreadId(java.lang.Long threadId_)

Deprecated.

Set the local id of the thread which contains this message.

Parameters:

threadId_ - The thread local id.

getAllowedActions

public java.lang.Integer[] getAllowedActions()

Deprecated.

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

Returns:

An array of the actions.

setAllowedActions

public void setAllowedActions(java.lang.Integer[] allowedActions_)

Deprecated.

Set the actions that the user can do on this object. NOTE: This setter exists only to allow for proper bean conversions when a Message object is returned by the API. It CANNOT be used to update the allowed actions for a Message

Parameters:

allowedActions_ - An array of the actions.