Package com.appiancorp.suiteapi.forums
Class Forum
java.lang.Object
com.appiancorp.suiteapi.forums.Forum
- 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.
Abstraction of a set of threads. Any given thread belongs to one and
only one forum. Multiple forums may exist. Traditionally, each forum
contains threads related to a single topic. This class manages the
properties related to the entire set of threads. It does not directly
contain the actual threads.
- 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. -
Constructor Summary
ConstructorDescriptionForum()
Deprecated.Constructs a forum object with all scalar fields set to null and all array fields set to zero-length arrays.Deprecated.Constructs a forum object with a particular name.Forum
(String name_, LocalObject[] relateds_) Deprecated.Constructs a forum object with a particular name and a set of related objects. -
Method Summary
Modifier and TypeMethodDescriptionInteger[]
Deprecated.Get the actions that the user can do on this object.Deprecated.Returns the creator of the forumDeprecated.Gets the date the forum was createdgetId()
Deprecated.Returns this object's local identifier,null
if the object was not identified locally using aLong
Id.getName()
Deprecated.Get the name of this forum.Deprecated.Get the array of other first-class objects related to this forum.Deprecated.Returns theRemoteId
of this object's instance identifier,null
if the object is only locally identified.getUuid()
Deprecated.Get the uuid of this forum.boolean
Deprecated.boolean
Deprecated.boolean
Deprecated.void
setAllowAnonymousPosting
(boolean allowAnonymousPosting_) Deprecated.void
setAllowedActions
(Integer[] allowedActions_) Deprecated.Set the actions that the user can do on this object.void
setCreator
(String creator_) Deprecated.void
setDateCreated
(Timestamp dateCreated_) Deprecated.void
Deprecated.Sets this object's local identifier.void
Deprecated.Set the name of this forum.void
setPublicForum
(boolean publicForum_) Deprecated.void
setRelateds
(LocalObject[] relateds_) Deprecated.Set the array of other first-class objects related to this forum.void
setRemoteId
(RemoteId remoteId_) Deprecated.Sets this object's remote identifier.void
setUserSubscribed
(boolean subscribed_) Deprecated.void
Deprecated.Set the uuid of this forum.toString()
Deprecated.String useful for debugging purposes.
-
Field Details
-
SORT_BY_ID
Deprecated. -
SORT_BY_NAME
Deprecated. -
SORT_BY_REPLICATED
Deprecated. -
SORT_BY_RELATEDS
Deprecated. -
SORT_BY_REMOTE_ID
Deprecated. -
SORT_BY_THREAD_COUNT
Deprecated. -
SORT_BY_MESSAGE_COUNT
Deprecated. -
SORT_BY_LAST_MESSAGE
Deprecated. -
SORT_BY_MESSAGE_COUNT_TODAY
Deprecated.
-
-
Constructor Details
-
Forum
public Forum()Deprecated.Constructs a forum object with all scalar fields set to null and all array fields set to zero-length arrays. -
Forum
Deprecated.Constructs a forum object with a particular name.- Parameters:
name_
- The name.
-
Forum
Deprecated.Constructs a forum object with a particular name and a set of related objects.- Parameters:
name_
- The name.relateds_
- The related objects.
-
-
Method Details
-
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. -
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:
-
getName
Deprecated.Get the name of this forum.- Returns:
- The name.
-
setName
Deprecated.Set the name of this forum.- Parameters:
name_
- The name.
-
getRelateds
Deprecated.Get the array of other first-class objects related to this forum.- Returns:
- Objects identifying the relateds.
-
setRelateds
Deprecated.Set the array of other first-class objects related to this forum.- Parameters:
relateds_
- Objects identifying the relateds.
-
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 aForum
object is returned by the API. It CANNOT be used to update the allowed actions for aForum
- Parameters:
allowedActions_
- An array of the actions.
-
isAllowAnonymousPosting
public boolean isAllowAnonymousPosting()Deprecated.- Returns:
- Returns the boolean allowAnonymousPosting.
-
setAllowAnonymousPosting
public void setAllowAnonymousPosting(boolean allowAnonymousPosting_) Deprecated.- Parameters:
allowAnonymousPosting_
- The allowAnonymousPosting to set.
-
isPublicForum
public boolean isPublicForum()Deprecated.- Returns:
- Returns the publicForum.
-
setPublicForum
public void setPublicForum(boolean publicForum_) Deprecated.- Parameters:
publicForum_
- The publicForum to set.
-
isUserSubscribed
public boolean isUserSubscribed()Deprecated.- Returns:
- Returns the _userSubscribed.
-
setUserSubscribed
public void setUserSubscribed(boolean subscribed_) Deprecated.- Parameters:
subscribed_
- The _userSubscribed to set.
-
getCreator
Deprecated.Returns the creator of the forum- Returns:
- Returns the creator.
-
setCreator
Deprecated.- Parameters:
creator_
- The creator to set.
-
getDateCreated
Deprecated.Gets the date the forum was created- Returns:
- Returns the date created.
-
setDateCreated
Deprecated.- Parameters:
dateCreated_
- The date created to set.
-
getUuid
@ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) public String getUuid()Deprecated.Get the uuid of this forum.- Returns:
- The uuid.
-
setUuid
Deprecated.Set the uuid of this forum.- Parameters:
uuid_
- The uuid.
-
toString
Deprecated.String useful for debugging purposes.
-