Package com.appiancorp.suiteapi.forums
Class Message
java.lang.Object
com.appiancorp.suiteapi.forums.Message
- All Implemented Interfaces:
GlobalId
,LocalId
,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.
A single message within a discussion.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated.static final Integer
Deprecated. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionInteger[]
Deprecated.Get the actions that the user can do on this object.Deprecated.Get the user name of the author of this message.double
Deprecated.Get the rating of this message.getBody()
Deprecated.Get the body of this message.Deprecated.Get the location of the body.Deprecated.Get the date-time this message was posted.int
getDepth()
Deprecated.Get the depth of this message.getId()
Deprecated.Returns this object's local identifier,null
if the object was not identified locally using aLong
Id.Deprecated.Get the local id of the message that is the parent to this message.int
Deprecated.Get the count of ratings that have been submitted for this messaage.Deprecated.Returns theRemoteId
of this object's instance identifier,null
if the object is only locally identified.Deprecated.Get the subject for this message.Deprecated.Get the local id of the thread which contains this message.boolean
Deprecated.Determine if the author of this message is anonymous.void
setAllowedActions
(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
Deprecated.Set the user name of the author of this message.void
setAverageRating
(double averageRating_) Deprecated.Set the rating of this message.void
Deprecated.Set the body of this message.void
setBodyLocation
(String filename_) Deprecated.Set the location of the body.void
setDatePosted
(Timestamp time_) Deprecated.Set the date-time this message was posted.void
setDepth
(int depth_) Deprecated.Set the depth of this message.void
Deprecated.Sets this object's local identifier.void
setParentId
(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
(String subject_) Deprecated.Set the subject for this message.void
setThreadId
(Long threadId_) Deprecated.Set the local id of the thread which contains this message.
-
Field Details
-
SORT_BY_ID
Deprecated. -
SORT_BY_PARENT_ID
Deprecated. -
SORT_BY_AUTHOR
Deprecated. -
SORT_BY_DATE_POSTED
Deprecated. -
SORT_BY_THREAD_ID
Deprecated. -
SORT_BY_SUBJECT
Deprecated. -
SORT_BY_BODY_LOCATION
Deprecated. -
SORT_BY_DEPTH
Deprecated. -
SORT_BY_AVERAGE_RATING
Deprecated. -
SORT_BY_RATING_COUNT
Deprecated. -
SORT_BY_ANONYMOUS_AUTHOR
Deprecated.
-
-
Constructor Details
-
Message
public Message()Deprecated.
-
-
Method Details
-
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
Deprecated.Get the user name of the author of this message.- Returns:
- The user name
-
setAuthor
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
Deprecated.Get the body of this message.- Returns:
- The body.
-
setBody
Deprecated.Set the body of this message.- Parameters:
body_
- The body.
-
getDatePosted
Deprecated.Get the date-time this message was posted.- Returns:
- The timestamp.
-
setDatePosted
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
Deprecated.Get the location of the body. The location should not be used by clients and may change without warning.- Returns:
- The lcoation.
-
setBodyLocation
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
Deprecated.Description copied from interface:LocalId
Returns this object's local identifier,null
if the object was not identified locally using aLong
Id. -
setId
Deprecated.Description copied from interface:LocalId
Sets this object's local identifier. -
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
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
Deprecated.Description copied from interface:GlobalId
Returns theRemoteId
of this object's instance identifier,null
if the object is only locally identified.- Specified by:
getRemoteId
in interfaceGlobalId
- Returns:
- Object's remote Id.
- See Also:
-
setRemoteId
Deprecated.Description copied from interface:GlobalId
Sets this object's remote identifier.- Specified by:
setRemoteId
in interfaceGlobalId
- Parameters:
remoteId_
- remove Id to set- See Also:
-
getSubject
Deprecated.Get the subject for this message.- Returns:
- The subject.
-
setSubject
Deprecated.Set the subject for this message.- Parameters:
subject_
- The subject.
-
getThreadId
Deprecated.Get the local id of the thread which contains this message.- Returns:
- The thread local id.
-
setThreadId
Deprecated.Set the local id of the thread which contains this message.- Parameters:
threadId_
- The thread local id.
-
getAllowedActions
Deprecated.Get the actions that the user can do on this object.- Returns:
- An array of the actions.
-
setAllowedActions
Deprecated.Set the actions that the user can do on this object. NOTE: This setter exists only to allow for proper bean conversions when aMessage
object is returned by the API. It CANNOT be used to update the allowed actions for aMessage
- Parameters:
allowedActions_
- An array of the actions.
-